-#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 245
+#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 276
\begin_document
\begin_header
\textclass book
\end_preamble
\language english
\inputencoding default
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
\graphics none
\paperfontsize default
\spacing single
\papersize default
\use_geometry false
\use_amsmath 0
+\use_esint 0
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\papersides 2
\paperpagestyle headings
\tracking_changes false
-\output_changes true
+\output_changes false
+\author ""
+\author ""
+\author ""
+\author ""
\end_header
\begin_body
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \tableofcontents{}
+\begin_inset LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{chap:config}
+\begin_inset LatexCommand label
+name "chap:config"
\end_inset
\family default
that define the keybindings used in LyX (see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:bindings}
+\begin_inset LatexCommand ref
+reference "sec:bindings"
\end_inset
, that will be used first.
See Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{chap:i18n}
+\begin_inset LatexCommand ref
+reference "chap:i18n"
\end_inset
, and section
-\begin_inset LatexCommand \ref{sec:bindings}
+\begin_inset LatexCommand ref
+reference "sec:bindings"
\end_inset
prepended to the name, that will be used first.
See Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{chap:i18n}
+\begin_inset LatexCommand ref
+reference "chap:i18n"
\end_inset
contains keyboard keymapping files.
See Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:keymap}
+\begin_inset LatexCommand ref
+reference "sec:keymap"
\end_inset
\series default
contains the text class files described in Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{chap:textclass}
+\begin_inset LatexCommand ref
+reference "chap:textclass"
\end_inset
\begin_layout List
\labelwidthstring 00.00.0000
-\family typewriter
-reLyX/
-\family default
- contains lots of files that together make up reLyX, the translator of
-\begin_inset Quotes eld
-\end_inset
-
-well behaved
-\begin_inset Quotes erd
-\end_inset
-
- LaTeX into LyX.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-
\family typewriter
scripts/
\family default
\labelwidthstring 00.00.0000
\family typewriter
-templates/
+templates/
\family default
-contains the standard LyX template files described in Chapter\InsetSpace ~
+ contains the standard LyX template files described in Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:templates}
+\begin_inset LatexCommand ref
+reference "sec:templates"
\end_inset
appearing on the toolbar.
See Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:ui}
+\begin_inset LatexCommand ref
+reference "sec:ui"
\end_inset
this file contains a list of all the languages currently supported by LyX.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-
-\family typewriter
-lyxrc.example
-\family default
- Deprecated and definitely obfuscated.
- This is the old style preferences file.
- It will probably disappear in the near future.
-\end_layout
-
\begin_layout Section
Your local configuration directory
\end_layout
and the resulting files are written in your local configuration directory
(see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:autodetected}
+\begin_inset LatexCommand ref
+reference "sec:autodetected"
\end_inset
\begin_layout Standard
Invoking LyX with the command line switch
\family typewriter
--userdir
+-userdir
\family default
+
\emph on
<some directory>
\emph default
These directories are completely independent (but read on).
Note that setting the environment variable
\family typewriter
-LYX_USERDIR_13x
+LYX_USERDIR_15x
\family default
to some value has exactly the same effect
\family typewriter
R
\bar default
econfigure
-\begin_inset LatexCommand \ref{sec:autodetected}
+\begin_inset LatexCommand ref
+reference "sec:autodetected"
\end_inset
LyXDir/lyxrc
\family default
.
- Users should use the
+ Users should use the
\family sans
-
\bar under
T
\bar default
\begin_layout Section
Bindings
-\begin_inset LatexCommand \label{sec:bindings}
+\begin_inset LatexCommand label
+name "sec:bindings"
\end_inset
\begin_layout Standard
LyX supports internationalization of the user interface (see Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{chap:i18n}
+\begin_inset LatexCommand ref
+reference "chap:i18n"
\end_inset
\begin_layout Section
User Interface
-\begin_inset LatexCommand \label{sec:ui}
+\begin_inset LatexCommand label
+name "sec:ui"
\end_inset
\end_layout
\begin_layout Section
-Converters, Formats, Viewers, Editors and Copiers
+\begin_inset LatexCommand label
+name "sec:converters-etc"
+
+\end_inset
+
+Converters, Formats, and Copiers
\end_layout
\begin_layout Standard
LyX has a powerful mechanism to convert to and from any file format using
external programs.
- Define a pair of formats, e.g.
+
+\end_layout
-\family typewriter
- LaTeX
+\begin_layout Subsection
+Formats
+\end_layout
+
+\begin_layout Standard
+The first step is to define your file formats, e.g.
+ PDF, if they are not already defined.
+ To do so, open the
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references:Converters
\family default
- and
+ dialog.
+ Enter a new format name; a new GUI name (used in, e.g., the View and Export
+ menus); and a file extension.
+ These are required.
+
+\end_layout
+
+\begin_layout Standard
+There are also two flags that can be set using the checkboxes in the dialog.
+ The
\family typewriter
-PDF
+document
\family default
-.
- Now define a converter from one format to the other.
- In our example, two possible mechanisms exist.
-\end_layout
+ flag tells LyX that a format is suitable for document export.
+ If this flag is set for a format, and if a suitable conversion route exists,
+ then the format will appear in the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\begin_layout Enumerate
-A direct conversion, from LaTeX to PDF using pdflatex
-\end_layout
+\bar under
+E
+\bar default
+xport
+\family default
+ menu.
+ The format will also appear in the
+\family sans
+\bar under
+V
+\bar default
+iew
+\family default
+ menu if it has a viewer associated with it.
+ (See below.) Pure image formats (e.g.\InsetSpace ~
-\begin_layout Enumerate
-A more convoluted route using intermediate formats and converters: LaTeX
- to DVI (using latex) to PostScript® (using dvips) to PDF (using ps2pdf).
+\family typewriter
+png
+\family default
+) should not have this flag set; formats that can both represent vector
+ graphics and documents (e.g.\InsetSpace ~
+
+\family typewriter
+pdf
+\family default
+) should have it set.
\end_layout
\begin_layout Standard
-LyX will always choose the shortest possible route, so you must specify
- two different Format names for
+The
\family typewriter
-.pdf
+vector
\family default
- files to be able to use either.
- Both are included by default in the
-\family sans
-Preferences
+ flag tells LyX whether a format can contain vector graphics.
+ This information is used to determine the target format of included graphics
+ for
+\family typewriter
+pdflatex
\family default
- dialog.
- Have a look and then invent your own!
+ export.
+ Included graphics may need to be converted to either
+\family typewriter
+pdf
+\family default
+,
+\family typewriter
+png
+\family default
+ or
+\family typewriter
+jpg
+\family default
+, since
+\family typewriter
+pdflatex
+\family default
+ cannot handle other image formats.
+ If an included graphic is not already in
+\family typewriter
+pdf
+\family default
+,
+\family typewriter
+png
+\family default
+ or
+\family typewriter
+jpg
+\family default
+ format, it is converted to
+\family typewriter
+pdf
+\family default
+ if the
+\family typewriter
+vector
+\family default
+ flag of the format is set, and otherwise to
+\family typewriter
+png
+\family default
+.
\end_layout
\begin_layout Standard
-Moreover, each Format can have a Viewer associated with it.
+A Format can have a Viewer associated with it.
For example, you might want to use
\family typewriter
ghostview
\family default
- to examine PostScript® files, or
+ to look at PostScript® files, or
\family typewriter
xdvi
\family default
to preview the LaTeX output.
- You can alter the viewer to use (and what options to pass to it) via the
-
+ You can enter the program to use as a viewer (and what options to pass
+ to it) in the Viewer field.
+ You can also modify the viewer associated with a pre-defined format simply
+ by changing what you find in this field, clicking the
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+Modify
+\family default
+ button, and then (if you're sure you want to do this) clicking the
+\family sans
+Apply
+\family default
+ or
+\family sans
+Save
+\family default
+ button.
+\begin_inset Foot
+status collapsed
-\bar under
-P
-\bar default
-references:Conversion
+\begin_layout Standard
+Changes to the formats are kept in the
+\family typewriter
+preferences
\family default
- dialog.
+ file in you local LyX directory (for example,
+\family typewriter
+$HOME/.lyx/
+\family default
+).
+ If you want to restore the defaults, edit this file and delete the lines
+ in the Formats and Converters sections.
+\end_layout
+
+\end_inset
+
For example, to change the
\family typewriter
dvi
.
\end_layout
+\begin_layout Standard
+If the operating system has a default viewer associated to a format, this
+ viewer is used instead of the one defined here in the Windows® and OS X
+ versions of LyX.
+ (It is planned to implement this feature on other platforms.)
+\end_layout
+
\begin_layout Standard
Editors are like viewers: Each Format can have an Editor associated to it,
- and they can be altered via the
+ entered in the Editor field, and the editor associated with a format can
+ be altered via the
\family sans
\bar under
T
\bar under
P
\bar default
-references:Conversion
+references:Converters
\family default
dialog.
- LyX uses them whenever an included file
+ LyX will launch the associated editor whenever an included file
\begin_inset Foot
status collapsed
needs to be edited.
\end_layout
+\begin_layout Subsection
+Copiers
+\end_layout
+
\begin_layout Standard
-Finally, each Format can have a Copier associated to it.
- Since all conversions from one Format to another take place in a temporary
+Each Format can have a Copier associated with it.
+ These are defined in the
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references:Copiers
+\family default
+ dialog.
+ Since all conversions from one Format to another take place in LyX's temporary
directory, it is sometimes necessary to modify a file before copying it
- to the temporary directory
+ to the temporary directory in order that the conversion may be performed.
\begin_inset Foot
status collapsed
\begin_layout Standard
-For example, the file may reference other files with relative filenames,
- which will become invalid in the temporary directory
+For example, the file may refer to other files---images, for example---using
+ relative filenames, and these may become invalid when the file is copied
+ to the temporary directory.
\end_layout
\end_inset
-.
This is done by the Copier: It copies a file to (or from) the temporary
directory and may modify it in the process.
+
+\end_layout
+
+\begin_layout Standard
+Copiers may also be used for other purposes.
+ For example, if appropriate converters are found, LyX will automatically
+ install copiers for the html and wordhtml formats.
+ When these formats are exported, the copier sees to it that not just the
+ main HTML file but various associated files (style files, images, and the
+ like) are also copied, and all these files are written to a subdirectory
+ of the directory in which the original LyX file was found.
+ The copier may of course be customized.
+ The optional -e argument takes a comma-separated list of extensions to
+ be copied; if it is omitted, all files will be copied.
+ The -t argument determines the extension added to the generated directory.
+ By default, it is
+\begin_inset Quotes eld
+\end_inset
+
+LyXconv
+\begin_inset Quotes erd
+\end_inset
+
+, so HTML generated from
+\family typewriter
+/path/to/filename.lyx
+\family default
+ will end up in
+\family typewriter
+/path/to/filename.html.LyXconv
+\family default
+.
+
+\end_layout
+
+\begin_layout Standard
+The definitions of the copiers may use four variables:
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$s The LyX system directory (e.g.,
+\family typewriter
+/usr/share/lyx
+\family default
+).
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$i The input file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$o The output file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$l The `LaTeX name'
+\end_layout
+
+\begin_layout Standard
+The latter is to be given in a form suitable for inclusion in a LaTeX
+\family typewriter
+
+\backslash
+include
+\family default
+ command and is relevant only when exporting files suitable for such inclusion.
+\end_layout
+
+\begin_layout Subsection
+Converters
+\end_layout
+
+\begin_layout Standard
+To define a converter from one format to another---e.g., LaTeX to PDF---select
+ the Converters panel.
+ Choose the `From' and `To' formats, and then enter the program to be used
+ in the conversion in the Converter field.
+
+\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 it then converts to DVI using the `LaTeX to DVI' converter,
+ and then it converts the resulting DVI file to PostScript®.
+ LyX finds such `chains' of converters automatically, and it will always
+ choose the shortest chain possible.
+ 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 pdflatex; via (DVI and) PostScript®, using
+ ps2pdf; or via DVI, using dvipdfm.
+ To define such alternate chains, you must define multiple target `file
+ formats'.
+ In the standard configuration, for example, formats named `pdf', `pdf2',
+ and `pdf3' are defined, all of which share the extension `pdf'.
+
+\end_layout
+
+\begin_layout Standard
+Several variables can be used in the definition of converters:
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$s The LyX system directory (e.g.,
+\family typewriter
+/usr/share/lyx
+\family default
+).
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$i The input file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$o The output file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$b The base filename of the input file
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+$$p The path to the input file
+\end_layout
+
+\begin_layout Standard
+In the `Extra Flag' field you can enter as many of the following flags as
+ you wish, separated by commas:
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+latex This converter runs some form of LaTeX.
+ (This will make LyX's LaTeX error logs available.)
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+needaux Needs the LaTeX .aux file for the conversion.
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+xml Output is XML.
+\end_layout
+
+\begin_layout Standard
+The following three variables are not really flags at all but take an argument
+ in the
+\family sans
+key\InsetSpace ~
+= value
+\family default
+ format.
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+parselog If set, the converter's standard error will be redirected to a
+ file
+\family typewriter
+infile.out
+\family default
+, and the script given as argument will be run as:
+\family typewriter
+script <infile.out >infile.log
+\family default
+.
+ The argument may contain $$s.
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+resultdir The name of the directory in which the
+\emph on
+converter
+\emph default
+ will dump the generated files.
+ LyX will not create this directory, and it does not copy anything into
+ it, though it will copy this directory to the destination.
+ The argument may contain $$b, which will be replaced by the basename of
+ the input and output files, respectively, when the directory is copied.
+\newline
+Note
+ that resultdir and usetempdir make no sense together.
+ The latter will be ignored if the former is given.
+\end_layout
+
+\begin_layout List
+\labelwidthstring 00.00.0000
+resultfile Determines the output filename and may, again, contain $$b.
+ Sensible only with resultdir, and optional even then; if not given, it
+ defaults to `index'.
+
+\end_layout
+
+\begin_layout Standard
+None of these last three are presently used in any of the converters that
+ are installed with LyX.
+ But see section
+\begin_inset LatexCommand ref
+reference "sub:LyX-and-Literate"
+
+\end_inset
+
+ of the Extended Features guide for some examples of how you might use parselog.
\end_layout
\begin_layout Section
\end_layout
\begin_layout Section
-ASCII export options
+Plain text export options
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- exported ASCII text files.
+ exported plain text files.
Note that LyX automatically detects and uses the best settings for your
system at installation time, but you can modify them if you disagree with
its interpretation.
\family typewriter
\series medium
-ASCII\InsetSpace ~
+Plain text\InsetSpace ~
roff
\family default
-
\series default
-This option defines the command used to produce better ASCII tables with
- the
+ This option defines the command used to produce better plain text tables
+ with the
\family typewriter
groff/troff/nroff
\family default
\family typewriter
\series medium
-ASCII\InsetSpace ~
+Plain text\InsetSpace ~
line\InsetSpace ~
length
\family default
-
\series default
-With this command you can set the default line length of the ASCII output
- file.
+ With this command you can set the default line length of the plain text
+ output file.
Setting it to 0 means endless lines.
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:autodetected}
+\begin_inset LatexCommand label
+name "sec:autodetected"
\end_inset
-There are several items that are detected for you when you run
+There are several items that are detected for you when you run
\family sans
\bar under
- T
+T
\bar default
ools
\bar under
\series medium
\backslash
-ascii_roff_command
+plaintext_roff_command
\family default
\series default
uses either
\begin_layout Chapter
Internationalizing LyX
-\begin_inset LatexCommand \label{chap:i18n}
+\begin_inset LatexCommand label
+name "chap:i18n"
\end_inset
\family default
, but in short, this is what you do (
\series bold
-xx
+xx
\series default
-denotes the language code):
+ denotes the language code):
\end_layout
\begin_layout Standard
\begin_layout Standard
+
\backslash
begin{sloppypar}
\end_layout
\family typewriter
lyx.pot
\family default
- doesn't exist, it can be remade with
+ doesn't exist, it can be remade with
\family typewriter
- make lyx.pot
+make lyx.pot
\family default
in that directory, or you can use an existing po-file for some other language
as a template).
\begin_layout Standard
We recommend that you use Emacs to do this, since the
\family typewriter
-gettext
+gettext
\family default
-distribution includes a nice mode that supports you in doing this.
+ distribution includes a nice mode that supports you in doing this.
\end_layout
\end_inset
\newline
\family typewriter
-msgfmt -o
+msgfmt -o
\family default
+
\series bold
xx
\family typewriter
\series default
-.mo <
+.mo <
\family default
+
\series bold
xx
\family typewriter
\begin_layout Standard
+
\backslash
end{sloppypar}
\end_layout
\begin_layout Standard
Adding a new po-file to the
\emph on
-distribution
+distribution
\emph default
-of LyX involves altering the configure scripts and more, but the way
+ of LyX involves altering the configure scripts and more, but the way
\family typewriter
gettext
\family default
\begin_layout Itemize
Check out the documentation translation web page at
-\begin_inset LatexCommand \url[The LyX Developer's Web Site]{http://www.devel.lyx.org}
+\begin_inset LatexCommand url
+name "The LyX Developer's Web Site"
+target "http://www.devel.lyx.org"
\end_inset
\begin_layout Itemize
Sometimes the original document (from the LyX-team) will be updated.
Use the ViewCVS tool available at
-\begin_inset LatexCommand \htmlurl{http://www.lyx.org/viewcvs.cgi/lyxdoc/}
+\begin_inset LatexCommand htmlurl
+target "http://www.lyx.org/viewcvs.cgi/lyxdoc/"
\end_inset
\begin_layout Standard
\emph on
-[Editor's Note: The following section is by
+[Editor's Note: The following section is by
+\emph default
+
\shape smallcaps
+\emph on
Ivan Schreter
\shape default
.
\begin_layout Standard
Let's look at a keyboard definition file a little closer.
- It is a plain ASCII file defining
+ It is a plain text file defining
\end_layout
\begin_layout Itemize
\family typewriter
key
-\emph on
+\family default
-\emph default
+\family typewriter
outstring
\end_layout
\begin_layout Quotation
acute (acu)
\hfill
-áéíóú
+áéíóú
\end_layout
\begin_layout Quotation
grave (gra)
\hfill
-àèìòù
+àèìòù
\end_layout
\begin_layout Quotation
macron (mac)
\hfill
- \i \={o}
-
+ ō
\end_layout
\begin_layout Quotation
tilde (til)
\hfill
-ñÑ
+ñÑ
\end_layout
\begin_layout Quotation
\begin_layout Standard
+
\backslash
b o
\end_layout
\begin_layout Quotation
cedilla (ced)
\hfill
-çÇ
+çÇ
\end_layout
\begin_layout Quotation
\begin_layout Standard
+
\backslash
d o
\end_layout
\begin_layout Quotation
circumflex (circu)
\hfill
-âêîôû
+âêîôû
\end_layout
\begin_layout Quotation
circle (circl)
\hfill
-Å\i \r{u}
-\i \r{U}
-
+ÅůŮ
\end_layout
\begin_layout Quotation
\begin_layout Standard
+
\backslash
t o
\end_layout
\begin_layout Quotation
breve (bre)
\hfill
-\i \u{a}
-
+ă
\begin_inset ERT
status inlined
\begin_layout Standard
+
\backslash
u o
\end_layout
\begin_layout Quotation
caron (car)
\hfill
-\i \v{c}
-\i \v{s}
-\i \v{z}
-
+čšž
\end_layout
\begin_layout Quotation
hungarian umlaut (hug)
\hfill
-\i \H{o}
-\i \H{u}
-
+őű
\end_layout
\begin_layout Quotation
umlaut (uml)
\hfill
-äöü
+äöü
\end_layout
\begin_layout Quotation
dot (dot)
\hfill
-\i \.{z}
-
+ż
\begin_inset ERT
status inlined
\begin_layout Standard
+
\backslash
.s
\end_layout
\begin_layout Section
International Keymap Stuff
-\begin_inset LatexCommand \label{sec:keymap}
+\begin_inset LatexCommand label
+name "sec:keymap"
\end_inset
\family roman
\emph on
char
+\family default
\emph default
+\family roman
\emph on
string
\end_layout
\begin_layout Standard
This will ma
\family roman
-p
+p
+\family default
+
+\family roman
\emph on
-char
+char
+\family default
\emph default
-to
+
+\family roman
+to
+\family default
+
+\family roman
\emph on
string
\emph default
.
- Note that in
+ Note that in
+\family default
+
+\family roman
\emph on
string
\emph default
-,
+,
+\family default
+
+\family roman
\shape up
the double-quote (")
+\family default
\shape default
- and
+
+\family roman
+and
+\family default
+
+\family roman
\shape up
the backslash (
\backslash
-)
+)
+\family default
\shape default
+
+\family roman
must be escaped with a preceding backslash (
\shape up
kmap
\family default
\shape default
- statement to cause the symbol
+ statement to cause the symbol
\family sans
\shape up
- /
+/
\family default
\shape default
-to be output for the keystroke
+ to be output for the keystroke
\family sans
\shape up
- &
+&
\family default
\shape default
-is:
+ is:
\end_layout
\begin_layout LyX-Code
\begin_layout LyX-Code
\backslash
-kmod
+kmod
\family roman
-
\emph on
char accent allowed
\end_layout
\begin_layout Standard
This will make the cha
\family roman
-racter
+racter
+\family default
+
+\family roman
\emph on
char
+\family default
+\emph default
+
+\family roman
\shape up
- be an accent
+\emph on
+be an accent
+\family default
+\shape default
\emph default
- on the
+
+\family roman
+\shape up
+on the
+\family default
+\shape default
+
+\family roman
+\shape up
\emph on
-allowed
+allowed
+\family default
+\shape default
\emph default
+
+\family roman
+\shape up
cha
\family default
racter(s).
with another key, produces the desired accent character.
For example, a German characte
\family roman
-r with an umlaut like
+r with an umlaut like
+\family default
+
+\family roman
\emph on
-ä
+ä
+\family default
\emph default
- can be produced in this manner.
+
+\family roman
+can be produced in this manner.
\end_layout
\end_inset
\begin_layout Standard
If you
\family roman
-hit
+hit
+\family default
+
+\family roman
\emph on
-char
+char
+\family default
\emph default
-and then another key not in
+
+\family roman
+and then another key not in
+\family default
+
+\family roman
\emph on
allowed
\emph default
-, you will get a
+, you will get a
+\family default
+
+\family roman
\emph on
-char
+char
+\family default
\emph default
-followed by the other, unallowed key, as output.
+\family roman
+followed by the other, unallowed key, as output.
+
\family default
-Note that a
+ Note that a
\family sans
\shape up
Backspace
\shape default
cancels a dead key, so if
\family roman
-you hit
+you hit
+\family default
+
+\family roman
\emph on
char
-\family sans
+\family default
+\emph default
+\family sans
\shape up
+\emph on
Backspace
\family default
\emph default
, the cursor will not go one position backwards but will instead cancel
the effect t
\family roman
-hat
+hat
+\family default
+\shape default
+
+\family roman
+\shape up
\emph on
char
+\family default
+\shape default
\emph default
- might have had on the next keystroke.
+
+\family roman
+\shape up
+might have had on the next keystroke.
\end_layout
\begin_layout LyX-Code
\backslash
-kxmod
-\family sans
-\emph on
-
+kxmod
\family roman
+\emph on
accent char result
\end_layout
\begin_layout Standard
This defines an exce
\family roman
-ption for
+ption for
+\family default
+
+\family roman
\emph on
-accent
+accent
+\family default
\emph default
-on
+
+\family roman
+on
+\family default
+
+\family roman
\emph on
char
\emph default
T
\shape up
he
+\family default
+\shape default
+
+\family roman
+\shape up
\emph on
- accent
+accent
+\family default
+\shape default
\emph default
-must
+
+\family roman
+\shape up
+must
\family default
-have been assigned a keystroke with a previous
+\shape default
+
+\shape up
+have been assigned a keystroke with a previous
+\shape default
+
\family typewriter
+\shape up
\backslash
kmo
\family default
declar
\family roman
-ation and
+ation and
+\family default
+
+\family roman
\emph on
-char
+char
+\family default
\emph default
-must not belong in the
+
+\family roman
+must not belong in the
+\family default
+
+\family roman
\emph on
-allowed
+allowed
+\family default
\emph default
-set of
+
+\family roman
+set of
+\family default
+
+\family roman
\emph on
accent
\emph default
.
- When
+ When
+\family default
+
+\family roman
+\shape up
+you enter the
+\family default
+\shape default
+
+\family roman
\shape up
-you enter the
\emph on
-accent char
+accent char
+\family default
+\shape default
\emph default
-sequence,
+
+\family roman
+\shape up
+sequence,
+\family default
+\shape default
+
+\family roman
+\shape up
\emph on
result
+\family default
+\shape default
\emph default
- is produced.
+
+\family roman
+\shape up
+ is produced.
If such a declaration does not exist in
\family default
- the
-\family sans
+\shape default
+
+\shape up
+the
+\shape default
\family typewriter
+\shape up
.kmap
\family default
\shape default
file and yo
\family roman
-u enter
+u enter
+\family default
+
+\family roman
\emph on
accent char
\emph default
-, you get
+, you get
+\family default
+
+\family roman
\emph on
-accent_key char
+accent_key char
+\family default
\emph default
- where
+
+\family roman
+ where
+\family default
+
+\family roman
\emph on
-accent_key
+accent_key
+\family default
\emph default
+
+\family roman
is the first arg
\family default
ument of the
\end_layout
\begin_layout Standard
-The following command produces causes äi to be produced when you enter acute-i
+The following command produces causes äi to be produced when you enter acute-i
('i):
\end_layout
\begin_layout Standard
This one is getting pretty esoteric.
- It allows you to combine the effect
+ It allows you to combine the effect
+\family roman
+of
+\family default
+
\family roman
- of
\emph on
accent1
+\family default
\emph default
- and
+
+\family roman
+and
+\family default
+
+\family roman
\emph on
accent2
+\family default
\emph default
- (in that order!) on
+
+\family roman
+(in that order!) on
+\family default
+
+\family roman
\emph on
allowed
+\family default
\emph default
- chars.
- The keystrokes for
+
+\family roman
+chars.
+ The keystrokes for
+\family default
+
+\family roman
\emph on
accent1
+\family default
\emph default
- and
+
+\family roman
+and
+\family default
+
+\family roman
\emph on
accent2
+\family default
\emph default
- must have be
+
+\family roman
+must have be
\family default
en set with a
\family typewriter
\shape default
command at
\family roman
-a
+a
+\family default
+
+\family roman
\emph on
previous
+\family default
\emph default
- point in the
+
+\family roman
+point in the
\family default
-file.
+ file.
\end_layout
\family roman
\shape up
-A backspace
+A backspace
\family default
\shape default
-in this case cancels the last dead key, so if you press
+ in this case cancels the last dead key, so if you press
\family sans
\shape up
- ;: Backspace i
+;: Backspace i
\family default
\shape default
-you get
+ you get
\family typewriter
\shape up
\family typewriter
\shape up
.kmap
-\family sans
-
\family default
\shape default
-mapping is performed, a
+ mapping is performed, a
\family typewriter
\shape up
.cde
\family typewriter
\shape up
.cdef
-\family sans
-
\family default
\shape default
-file is a sequence of declarations of the form
+ file is a sequence of declarations of the form
\end_layout
\begin_layout LyX-Code
\family roman
\emph on
char_index_in_set
+\family default
\emph default
+\family roman
\emph on
string
\end_layout
\family default
being escap
\family roman
-ed in
+ed in
+\family default
+
+\family roman
\emph on
string
\emph default
.
- Note that
+ Note that
\family default
-the same character can apply to more than one string.
+ the same character can apply to more than one string.
In the
\family typewriter
i
\shape up
so-8859-7.cdef
-\family sans
-
\family default
\shape default
-file you have
+ file you have
\end_layout
\begin_layout LyX-Code
\begin_inset Quotes eld
\end_inset
-\i \^{}
-
+ ̂
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-ê
+ê
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:savlang}
+\begin_inset LatexCommand label
+name "sec:savlang"
\end_inset
\begin_layout Chapter
Installing New Document Classes, Layouts, and Templates
-\begin_inset LatexCommand \label{chap:textclass}
+\begin_inset LatexCommand label
+name "chap:textclass"
\end_inset
.
This should create
\family typewriter
-/usr/local/texmf/ls-R
+/usr/local/texmf/ls-R
\family default
-amongst others.
+ amongst others.
\end_layout
\begin_layout Enumerate
\begin_layout Standard
This indicates that your text class uses the foo.sty package.
- Finally, it is also possible to declare classes for SGML and DocBook code.
+ Finally, it is also possible to declare classes for DocBook code.
Typical declarations will look like
\end_layout
\size small
#
\backslash
-DeclareSGMLClass{SGML (LinuxDoc)}
-\end_layout
-
-\begin_layout Standard
-or
-\end_layout
-
-\begin_layout LyX-Code
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-#
-\backslash
DeclareDocBookClass[article]{SGML (DocBook article)}
\end_layout
\begin_layout Standard
+
\backslash
begin{sloppypar}
\end_layout
\bar default
ettings
\family default
-\emph on
-
-\emph default
-dialog.
+ dialog.
This setting (same goes for
\family typewriter
Sides
, 2
\family default
] Whether the class-default should be printing on one or both sides of the
- paper.
- Can be changed in the
-\emph on
-
+ paper.
+ Can be changed in the
\family sans
-\emph default
\bar under
D
\bar default
\family typewriter
\series medium
PageStyle
-\series default
-
\family default
-[
+\series default
+ [
\family typewriter
\emph on
plain
\bar default
ettings
\family default
-\emph on
-
-\emph default
-dialog.
+ dialog.
\end_layout
\begin_layout Description
class.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:classoptions}
+\begin_inset LatexCommand ref
+reference "sec:classoptions"
\end_inset
\family typewriter
\series medium
-ProvidesAmsmath
-\family default
-\series default
- [
-\family typewriter
-\emph on
-0
-\emph default
-, 1
-\family default
-] Whether the class already loads the
-\family typewriter
-amsmath
-\family default
- package.
- This is the case of the
-\family typewriter
-amsart
-\family default
- and
-\family typewriter
-amsbook
-\family default
- document classes.
-\end_layout
-
-\begin_layout Description
-
-\family typewriter
-\series medium
-ProvidesMakeidx
+Provides
\family default
\series default
- [
-\family typewriter
-\emph on
-0
-\emph default
-, 1
-\family default
-] Whether the class already provides the functionality of the
-\family typewriter
-makeidx
-\family default
- package.
- This is the case of the
-\family typewriter
-amsart
-\family default
- and
-\family typewriter
-amsbook
-\family default
- document classes.
-\end_layout
-
-\begin_layout Description
-
+[
\family typewriter
-\series medium
-ProvidesUrl
+string
\family default
-\series default
- [
+] [
\family typewriter
\emph on
0
\emph default
, 1
\family default
-] Whether the class already provides the functionality of the
-\family typewriter
-url
-\family default
- package.
- This is the case of the
+] Whether the class already provides the feature
\family typewriter
- AASTeX
+ string
\family default
-document class.
+.
+ A feature is in general the name of a package (amsmath, makeidx, \SpecialChar \ldots{}
+) or a
+ macro (url, boldsymbol,\SpecialChar \ldots{}
+); the complete list of supported features is unfortunat
+ely not documented.
\end_layout
\begin_layout Description
This is used to describe the default font of the document.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
\family default
means that the macro with name
\family typewriter
-TitleLaTeXCommand
+TitleLatexName
\family default
will be inserted after the last layout which has
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
- should be enclosed into the
+ should be enclosed into the
\family typewriter
- TitleLaTeXCommand
+TitleLatexName
\family default
-environment
+ environment
\family typewriter
.
\end_layout
\family typewriter
\series medium
-TitleLatexCommand
+TitleLatexName
\family default
\series default
[
If the style already exists, it will redefine some of its parameters instead.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:style}
+\begin_inset LatexCommand ref
+reference "sec:style"
\end_inset
This sequence defines a new float.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:floats}
+\begin_inset LatexCommand ref
+reference "sec:floats"
\end_inset
\series medium
CharStyle\SpecialChar \ldots{}
End
-\series default
-
\family default
-This section defines a new character style.
+\series default
+ This section defines a new character style.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:charstyle}
+\begin_inset LatexCommand ref
+reference "sec:charstyle"
\end_inset
This sequence defines a new counter.
See Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:counter}
+\begin_inset LatexCommand ref
+reference "sec:counter"
\end_inset
\begin_layout Standard
+
\backslash
end{sloppypar}
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:classoptions}
+\begin_inset LatexCommand label
+name "sec:classoptions"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:style}
+\begin_inset LatexCommand label
+name "sec:style"
\end_inset
\begin_layout Standard
+
\backslash
begin{sloppypar}
\end_layout
\family typewriter
\series medium
InTitle
+\family default
\series default
- [1, 0]
+
+\family typewriter
+[1, 0]
\family default
-If 1, marks the layout as being part of a title block (see also the
+ If 1, marks the layout as being part of a title block (see also the
\family typewriter
- TitleLatexType
+TitleLatexType
\family default
and
\family typewriter
-TitleLatexCommand
+TitleLatexName
\family default
global entries)
\end_layout
\series default
[
\family typewriter
-1,
+1,
+\family default
+
+\family typewriter
\emph on
0
\family default
\series default
[
\family typewriter
-Chapter, Section, Subsection, Subsubsection,
-\newline
-Paragraph, Subparagraph, EnumI,
- EnumII, EnumIII, EnumIV
+string=""
\family default
]
\newline
-The name of the counter for automatic numbering.
+The name of the counter for automatic numbering (see Section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:counter"
+
+\end_inset
+
+ for details).
This must be given if
\family typewriter
\series medium
is set, this string can be contain special formatting commands as explained
in Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:counter}
+\begin_inset LatexCommand ref
+reference "sec:counter"
\end_inset
\family typewriter
string=""
\family default
-] If non-empty, this is used inside the appendix instead of
+] This is used inside the appendix instead of
\family typewriter
LabelString
\family default
.
-
+ Note that every
+\family typewriter
+LabelString
+\family default
+ statement resets
+\family typewriter
+\series medium
+LabelStringAppendix
+\family default
+\series default
+ too
+\family typewriter
+\series medium
+.
\end_layout
\begin_layout Description
\begin_layout Standard
\emph on
-Note from Jean-Marc:
+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.
+ I'm not sure that this setting has much use, and it should probably be
+ removed in later versions.
\end_layout
\end_inset
\series default
[
\family typewriter
-0,
+0,
+\family default
+
+\family typewriter
\emph on
1
\family default
\emph on
single
\emph default
-, onehalf, double, other
+, onehalf, double, other
\family default
+
\emph on
value
\emph default
\family typewriter
\series medium
-Font
+Font
\family default
\series default
-The font used for both the text body
+ The font used for both the text body
\emph on
and
\emph default
the label.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
The font used for the text body .
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
The font used for the label.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
\begin_layout Standard
+
\backslash
end{sloppypar}
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:floats}
+\begin_inset LatexCommand label
+name "sec:floats"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:charstyle}
+\begin_inset LatexCommand label
+name "sec:charstyle"
\end_inset
\family typewriter
\series medium
-Font
+Font
\family default
\series default
-The font used for both the text body
+ The font used for both the text body
\emph on
and
\emph default
the label.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
The font used for the label.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:fonts}
+\begin_inset LatexCommand ref
+reference "sec:fonts"
\end_inset
\series default
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:style}
+\begin_inset LatexCommand ref
+reference "sec:style"
\end_inset
\series default
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:style}
+\begin_inset LatexCommand ref
+reference "sec:style"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:counter}
+\begin_inset LatexCommand label
+name "sec:counter"
\end_inset
\family default
r
\family typewriter
-ing
+ing
\family default
-and
+ and
\family typewriter
LabelStringAppendix
\family default
\series default
to translate
\family typewriter
-counter
+counter
\family default
-to arabic numerals, like 1, 2, 3\SpecialChar \ldots{}
+ to arabic numerals, like 1, 2, 3\SpecialChar \ldots{}
\begin_inset Foot
status collapsed
\bar no
\noun off
\color none
-Actually, the situation is a bit more complicated than that: any
-\family typewriter
+Actually, the situation is a bit more complicated than that: any
+\family default
\series default
\shape default
+\emph default
+\bar default
+
+\family typewriter
\size default
\emph on
-\bar default
\noun default
numbertype
\family roman
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:fonts}
+\begin_inset LatexCommand label
+name "sec:fonts"
\end_inset
\end_layout
\begin_layout LyX-Code
-Font
+Font
\family roman
\emph on
- or
+or
\family default
\emph default
-LabelFont
+ LabelFont
\end_layout
\begin_layout LyX-Code
\series default
[
\family typewriter
-tiny, small,
+tiny, small,
+\family default
+
+\family typewriter
\emph on
normal
\emph default
\family typewriter
\series medium
Color
-\series default
-
\family default
-[
+\series default
+ [
\family typewriter
\emph on
none
\begin_layout Section
Creating Templates
-\begin_inset LatexCommand \label{sec:templates}
+\begin_inset LatexCommand label
+name "sec:templates"
\end_inset
\bar under
P
\bar default
-references
+references
\family default
-dialog (tabs
+ dialog (tabs
\family sans
Input
\family default
\bar under
N
\bar default
-ew
+ew
\family default
-in order to provide useful defaults.
+ in order to provide useful defaults.
To create this template from inside LyX, all you have to do is to open
a document with the correct settings, and use the
\family sans
\end_inset
One often requested feature from LyX users is to be able to interface LyX
- with XFig, Dia, or other similar applications that specialize in producing
+ with Xfig, Dia, or other similar applications that specialize in producing
a certain kind of diagram, figure, schematic or whatever material might
be relevant to include in your document.
Previously, it was only possible to include boring, static, fixed images
\begin_layout Itemize
The graphics stuff does not provide any mechanisms for coping with different
- exported formats such as DocBook, HTML or raw Ascii
+ exported formats such as DocBook, HTML or plain text
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The external material feature is based on the concept of a
+The external material feature is based on the concept of a
\emph on
- template
+template
\emph default
.
A template is a specification of how LyX should interface with a certain
kind of material.
- As bundled, LyX comes with predefined templates for XFig figures, Dia diagrams,
+ As bundled, LyX comes with predefined templates for Xfig figures, Dia diagrams,
various raster format images, gnuplot, and more.
- You can check the actual list by using the
+ You can check the actual list by using the menu
\family sans
Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
External
\family default
\InsetSpace ~
\family sans
-Material
+Material
\family default
-command.
+.
Furthermore, it is possible to roll your own template to support a specific
kind of material.
Later we'll describe in more detail what is involved, and hopefully you
Another basic idea of the external material feature is to distinguish between
the original file that serves as a base for final material and the produced
file that is included in your exported or printed document.
- For example, consider the case of a figure produced with XFig.
- The XFig application itself works on an original file with the
+ For example, consider the case of a figure produced with
+\family typewriter
+Xfig
+\family default
+.
+ The Xfig application itself works on an original file with the
\family typewriter
.fig
\family default
while you are in the process of writing the document.
Furthermore, it provides us with the flexibility that is needed to support
multiple export formats.
- For instance, in the case of an Ascii resulting file, it is not exactly
- an award-winning idea to include the figure as raw PostScript.
+ For instance, in the case of a plain text file, it is not exactly an award-winn
+ing idea to include the figure as raw PostScript.
Instead, you'd either prefer to just include a reference to the figure,
- or try to invoke some graphics to Ascii converter to make the final result
- look similar to the real graphics.
- The external material management allows you to do this, because it is parameter
-ized on the different export formats that LyX supports.
-\end_layout
-
-\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an XFig figure, you are able to invoke
-\family typewriter
-xfig
-\family default
- on the original file with a single click from within the external material
- dialog in LyX, and also preview the produced PostScript file with
-\family typewriter
-ghostview
-\family default
- with another click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Standard
-This paragraph is outdated
-\end_layout
-
-\end_inset
-
-So, all in all, LyX has information about a number of different programs
- to use behind the scenes in order to realize all of this machinery.
- This information, in fact, is exactly what is contained in the templates.
- To each template, there is associated a list of command lines that are
- used to invoke applications, convert the original file to the produced
- file, and more.
- This mechanism allows the advanced user to extend the capabilities of LyX
- without fiddling with the source code.
- It requires some footwork to define all the different commands and flags,
- but luckily, the LyX team did all the hard work and specified these for
- you.
-\end_layout
-
-\begin_layout Standard
-But before the trees grow into the skies, we have to admit that we did take
- one tiny short-cut.
- Since you can produce many different kinds of files to go with each exported
- format, one could also expect that it would be possible to preview each
- product.
- The LyX team decided against this in order to keep the user interface simple.
- Instead of providing a button for each exported file format, we decided
- to introduce the concept of the primary file format and just have one button.
- When you press
-\family sans
-View
-\family default
-\InsetSpace ~
-
-\family sans
-result
-\family default
- in the external material dialog, you will get a view of the produced file
- in the primary file format.
- And the primary file format is specified by your document class.
- For most document classes, the primary file format is LaTeX, but for the
- DocBook document classes, the primary file format is DocBook.
- So, when you view the produced file, keep in mind that it will only be
- a preview of what the main result will be.
- If you want to see how other exported formats turn out, you have to export
- them and preview them by hand.
-\end_layout
-
-\begin_layout Section
-The external material dialog
-\end_layout
-
-\begin_layout Standard
-You insert external material from the
-\family sans
-\bar under
-I
-\bar default
-nsert
-\family default
- menu.
- When you do this, a button is inserted into your document, and the external
- material dialog is shown.
- This dialog allows you to describe exactly what material should be included,
- and also how it should be included.
- Furthermore, it provides access to the external applications to either
- view, edit or produce the material that is used in the resulting file.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Standard
-This paragraph is outdated
-\end_layout
-
-\end_inset
-
-At the top of this dialog, there is a drop-down list where you can chose
- which template should be used.
- Just below the template drop-down, there's a text area with a short blurb
- about the chosen template that should help you use it.
- Most often, it will provide a short description of the template, and a
- few hints on how to parameterize the use of it.
- Further down, you'll find a filename input field along with a
-\begin_inset Quotes eld
-\end_inset
-
-Browse
-\begin_inset Quotes erd
-\end_inset
-
- button that allows you to chose which file should be included with the
- standard file browser.
- Thus this field specifies the original file.
- Since the produced file is automatically generated when needed, there is
- no need to give access to it in the user interface.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Standard
-This paragraph is outdated
-\end_layout
-
-\end_inset
-
-At the bottom of the dialog, you'll find a general input box called
-\family sans
-Parameters
-\family default
-.
- This box is generally used to parameterize the specific template.
- The specific use should be covered in the help blurb associated with the
- template, but it typically allows you to define variations on how the produced
- file should be generated.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Standard
-This paragraph is outdated
-\end_layout
-
-\end_inset
-
-At the right side of the dialog, you'll find three buttons:
-\family sans
-Edit
-\family default
-\InsetSpace ~
-
-\family sans
-file
-\family default
-,
-\family sans
-View
-\family default
-\InsetSpace ~
-
-\family sans
-result
-\family default
-, and
-\family sans
-Update
-\family default
-\InsetSpace ~
-
-\family sans
-result
-\family default
-.
- These in turn allow you to edit your original file with the appropriate
- editing application, view the produced file as included in the primary
- format document, and finally force an update of the resulting material
- in the primary format.
- Normally, the
-\family sans
-Update
-\family default
-\InsetSpace ~
+ or try to invoke some graphics to Ascii converter to make the final result
+ look similar to the real graphics.
+ The external material management allows you to do this, because it is parameter
+ized on the different export formats that LyX supports.
+\end_layout
-\family sans
-result
-\family default
- button will be disabled, because most templates are configured to automatically
- update the produced file when needed.
- In those cases, there is no need to force the production of a new produced
- file.
- However, some templates are configured to not be automatically producing
- the residual product, because the cost of producing the produced file might
- be so large that it would be a pain to do it all the time.
- Those types are known as
-\emph on
-manual
-\emph default
- external material.
- In those cases, you can use the button to force the production of the produced
- file exactly when you need it, and thus control the amount of work that
- is done.
- In fact, it is
-\emph on
-your
-\emph default
- responsibility to do this to keep the produced files current at all times:
- before printing, before exporting, before viewing, etc.
- At some time in the future, it might be possible that LyX will help you
- with this task.Any changes in the template, filename or parameters are actually
- applied whenever you press
-\family sans
-Edit file
+\begin_layout Standard
+Besides supporting the production of different products according to the
+ exported format, it supports tight integration with editing and viewing
+ applications.
+ In the case of an XFig figure, you are able to invoke
+\family typewriter
+Xfig
\family default
-,
-\family sans
-View
+ on the original file with a single click from within the external material
+ dialog in LyX, and also preview the produced PostScript file with
+\family typewriter
+ghostview
\family default
-\InsetSpace ~
+ with another click.
+ No more fiddling around with the command line and/or file browsers to locate
+ and manipulate the original or produced files.
+ In this way, you are finally able to take full advantage of the many different
+ applications that are relevant to use when you write your documents, and
+ ultimately be more productive.
+\end_layout
+\begin_layout Section
+External material dialog
+\end_layout
+
+\begin_layout Standard
+The
\family sans
-result
-\family default
- or
-\family sans
-Update
+External Material
\family default
-\InsetSpace ~
-
+ dialog is described in the
\family sans
-result
+\emph on
+EmbeddedObjects
\family default
- buttons.
+\emph default
+ manual.
\end_layout
\begin_layout Section
FormatEnd
\end_layout
-\begin_layout LyX-Code
-Format LinuxDoc
-\end_layout
-
\begin_layout LyX-Code
Product "[XFig: $$FName]"
\end_layout
\family typewriter
\series medium
Format\InsetSpace ~
-LaTeX|PDFLaTeX|Ascii|DocBook|LinuxDoc
+LaTeX|PDFLaTeX|PlainText|DocBook
\family default
\series default
The primary document file format that this format definition is for.
Format
\family default
section for all formats.
- Use a dummy text when no representation is available (see the LinuxDoc
- format in the example above).
+ Use a dummy text when no representation is available.
Then you can at least see a reference to the external material in the exported
document.
\end_layout
\series default
This command specifies a preamble snippet that will be included in the
LaTeX preamble.
- It has to be defined using
+ It has to be defined using
\family typewriter
- PreambleDef
+PreambleDef
\family default
\SpecialChar \ldots{}
Menu
\end_layout
+\begin_layout Standard
+Note that the following bindings are for LyX with English menus.
+ The second character of the binding depends on the menu language.
+ For example
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+M-i r
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ is with German menus
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+M-e q
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ To find out the shortcuts of your language press the Meta (Alt)-key and
+ press then the keys of the underlined characters of the menu names.
+\end_layout
+
\begin_layout Subsection
File
\end_layout
\family sans
M-f\InsetSpace ~
-a
+a
+\family default
+
\family typewriter
buffer-write-as
\end_layout
\family sans
M-f\InsetSpace ~
-f
+f
+\family default
+
\family typewriter
buffer-export fax
\end_layout
\family sans
M-f\InsetSpace ~
-n
+n
+\family default
+
\family typewriter
buffer-new
\end_layout
\family sans
M-f\InsetSpace ~
-t
+t
+\family default
+
\family typewriter
buffer-new-template
\end_layout
\family sans
M-f\InsetSpace ~
v
+\family default
+
\family typewriter
- file_vc
+file_vc
\family default
submenu
\end_layout
\family sans
h
+\family default
+
\family typewriter
- vc-history
+vc-history
\end_layout
\begin_layout List
\family sans
i
+\family default
+
\family typewriter
- vc-check-in
+vc-check-in
\end_layout
\begin_layout List
\family sans
l
+\family default
+
\family typewriter
- vc-revert
+vc-revert
\end_layout
\begin_layout List
\family sans
o
+\family default
+
\family typewriter
- vc-check-out
+vc-check-out
\end_layout
\begin_layout List
\family sans
r
+\family default
+
\family typewriter
- vc-register
+vc-register
\end_layout
\begin_layout List
\family sans
u
+\family default
+
\family typewriter
- vc-undo-last
+vc-undo-last
\end_layout
\end_deeper
\family sans
M-f\InsetSpace ~
-x
+x
+\family default
+
\family typewriter
lyx-quit
\end_layout
\family sans
a
+\family default
+
\family typewriter
- floats-operate openfoot
+floats-operate openfoot
\end_layout
\begin_layout List
\family sans
c
+\family default
+
\family typewriter
- floats-operate closefoot
+floats-operate closefoot
\end_layout
\begin_layout List
\family sans
f
+\family default
+
\family typewriter
- floats-operate openfig
+floats-operate openfig
\end_layout
\begin_layout List
\family sans
m
+\family default
+
\family typewriter
- melt
+melt
\end_layout
\begin_layout List
\family sans
o
+\family default
+
\family typewriter
- open-stuff
+open-stuff
\end_layout
\begin_layout List
\family sans
t
+\family default
+
\family typewriter
- floats-operate closefig
+floats-operate closefig
\end_layout
\end_deeper
\family typewriter
dialog-preferences
-\family sans
+\family default
\end_layout
\family sans
M-e\InsetSpace ~
-u
+u
+\family default
+
\family typewriter
undo
\end_layout
\family sans
M-e\InsetSpace ~
-x
+x
+\family default
+
\family typewriter
edit_paste
\family default
\family default
\family typewriter
-file-insert-ascii lines
+file-insert-plaintext lines
\end_layout
\begin_layout List
\family default
\family typewriter
-file-insert-ascii paragraphs
+file-insert-plaintext paragraphs
\end_layout
\begin_layout List
\end_layout
\begin_layout Subsubsection
-L
+
\family sans
-ayout\SpecialChar \menuseparator
+Layout\SpecialChar \menuseparator
Character
\family default
\family sans
M-c\InsetSpace ~
-b
+b
+\family default
+
\family typewriter
font-bold
\end_layout
\family sans
M-c\InsetSpace ~
-c
+c
+\family default
+
\family typewriter
font-noun
\end_layout
\family sans
M-c\InsetSpace ~
-e
+e
+\family default
+
\family typewriter
font-emph
\end_layout
\family sans
M-c\InsetSpace ~
-m
+m
+\family default
+
\family typewriter
math-mode
\end_layout
\family sans
M-c\InsetSpace ~
-r
+r
+\family default
+
\family typewriter
font-roman
\end_layout
\family sans
M-c\InsetSpace ~
-s
+s
+\family default
+
\family typewriter
font-sans
\end_layout
\family sans
M-c\InsetSpace ~
-t
-\family typewriter
-tex-mode
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-
-\family sans
-M-c\InsetSpace ~
-u
+u
+\family default
+
\family typewriter
font-underline
\end_layout
\family sans
M-c\InsetSpace ~
-space
+space
+\family default
+
\family typewriter
font-default
\end_layout
\family sans
M-c\InsetSpace ~
-Down
+Down
+\family default
+
\family typewriter
word-lowcase
\end_layout
\family sans
M-c\InsetSpace ~
-Up
+Up
+\family default
+
\family typewriter
word-upcase
\end_layout
\family sans
M-c\InsetSpace ~
-Right
+Right
+\family default
+
\family typewriter
word-capitalize
\end_layout
\family sans
M-s\InsetSpace ~
-h
+h
+\family default
+
\family typewriter
font-size huge
\end_layout
\family sans
M-s\InsetSpace ~
-0
+0
+\family default
+
\family typewriter
font-size huger
\end_layout
\family sans
M-s\InsetSpace ~
-3
+3
+\family default
+
\family typewriter
font-size smaller
\end_layout
\family sans
M-s\InsetSpace ~
-8
+8
+\family default
+
\family typewriter
font-size largest
\end_layout
\family sans
M-s\InsetSpace ~
-9
+9
+\family default
+
\family typewriter
font-size huge
\end_layout
\family sans
M-s\InsetSpace ~
-plus
+plus
+\family default
+
\family typewriter
font-size increase
\end_layout
\family sans
M-s\InsetSpace ~
-minus
+minus
+\family default
+
\family typewriter
font-size decrease
\end_layout
\family sans
C-q
+\family default
+
\family typewriter
- quote-insert
+quote-insert
\end_layout
\begin_layout List
\labelwidthstring 00.00.0000
\family sans
-M-S-percent
+M-S-percent
+\family default
+
\family typewriter
find-replace
\end_layout
\labelwidthstring 00.00.0000
\family sans
-F3
+F3
+\family default
+
\family typewriter
buffer-open
\end_layout
\family default
\family typewriter
-copy
+copy
\family default
--- Copy, cut, paste is as in Sciword,
+ -- Copy, cut, paste is as in Sciword,
\family typewriter
- C-c
+C-c
\family default
,
\family typewriter
\family default
\family typewriter
-math-display
+math-display
\family default
--- Display equation toggle: type
+ -- Display equation toggle: type
\family typewriter
C-d
\family default
\family typewriter
math-insert
\backslash
-frac
+frac
\family default
--- Fractions: type
+ -- Fractions: type
\family typewriter
C-f
\family default
\family typewriter
math-insert
\backslash
-int
+int
\family default
--- Inserts
+ -- Inserts
\begin_inset Formula $\int$
\end_inset
\family default
\family typewriter
-math-mode
+math-mode
\family default
--- A text/math toggle (
+ -- A text/math toggle (
\family typewriter
m
\family default
\family default
\family typewriter
-math-number
+math-number
\family default
--- Add/remove numbering in a single equation.
+ -- Add/remove numbering in a single equation.
\end_layout
\begin_layout List
\family default
\family typewriter
-file-open
+file-open
\family default
--- Open a new document.
+ -- Open a new document.
(W*ndows)
\end_layout
\family typewriter
math-insert
\backslash
-sqrt
+sqrt
\family default
--- Square root sign
+ -- Square root sign
\begin_inset Formula $\sqrt{x}$
\end_inset
\family typewriter
math-insert
\backslash
-root
+root
\family default
--- root sign
+ -- root sign
\begin_inset Formula $\sqrt[n]{x}$
\end_inset
\family default
\family typewriter
-math-mode
+math-mode
\family default
--- Another binding for a switch between the text and the math mode (
+ -- Another binding for a switch between the text and the math mode (
\family typewriter
t
\family default
\family default
\family typewriter
-font-underline
+font-underline
\family default
---
+ --
\bar under
Underline
\bar default
\family default
\family typewriter
-paste
+paste
\family default
--- W*ndows heritage.
+ -- W*ndows heritage.
\end_layout
\begin_layout List
\family default
\family typewriter
-buffer-close
+buffer-close
\family default
--- Close the current document (again, a W*ndows heritage).
+ -- Close the current document (again, a W*ndows heritage).
\end_layout
\begin_layout List
\family default
\family typewriter
-redo
+redo
\family default
--- the
+ -- the
\begin_inset Quotes eld
\end_inset
\family default
\family typewriter
-math-delim ( )
+math-delim ( )
\family default
--- for convenience, pressing
+ -- for convenience, pressing
\family typewriter
Ctrl-9
\family default
\family default
\family typewriter
-math-delim langle rangle
+math-delim langle rangle
\family default
--- angular delimiters
+ -- angular delimiters
\begin_inset Formula $\left\langle \right\rangle $
\end_inset
\begin_inset Quotes erd
\end_inset
- inserts á.
+ inserts á.
Some accents work only in math mode and others only in text mode.
\end_layout
\family default
\family typewriter
-accent-dot
+accent-dot
\family default
--- overdot accent, \i \.{a}
- (text mode only).
+ -- overdot accent, ȧ (text mode only).
\end_layout
\begin_layout List
\family typewriter
math-insert
\backslash
-dot
+dot
\family default
--- overdot accent,
+ -- overdot accent,
\begin_inset Formula $\dot{a}$
\end_inset
\family default
\family typewriter
-accent-umlaut
+accent-umlaut
\family default
--- umlaut accent, ä (text mode only)
+ -- umlaut accent, ä (text mode only)
\end_layout
\begin_layout List
\family typewriter
math-insert
\backslash
-ddot
+ddot
\family default
--- double dot accent,
+ -- double dot accent,
\begin_inset Formula $\ddot{a}$
\end_inset
\family default
\family typewriter
-accent-grave
+accent-grave
\family default
--- grave accent à (text mode only, use
+ -- grave accent à (text mode only, use
\family typewriter
\backslash
\family default
\family typewriter
-accent-tilde
+accent-tilde
\family default
--- tilde accent ã (text mode only, use
+ -- tilde accent ã (text mode only, use
\family typewriter
\backslash
\family default
\family typewriter
-accent-acute
+accent-acute
\family default
--- acute accent á (text mode only, use
+ -- acute accent á (text mode only, use
\family typewriter
\backslash
\family default
\family typewriter
-accent-circumflex
+accent-circumflex
\family default
--- circumflex (caret) accent â (text mode only, use
+ -- circumflex (caret) accent â (text mode only, use
\family typewriter
\backslash
\family default
\family typewriter
-buffer-write
+buffer-write
\family default
--- Save current document.
+ -- Save current document.
\end_layout
\begin_layout List
\family default
\family typewriter
-buffer-export latex
+buffer-export latex
\family default
--- Write a LaTeX file for the current document.
+ -- Write a LaTeX file for the current document.
\end_layout
\begin_layout List
\family default
\family typewriter
-find-replace
+find-replace
\family default
--- Find and replace dialog.
+ -- Find and replace dialog.
\end_layout
\begin_layout List
\family default
\family typewriter
-buffer-close
+buffer-close
\family default
--- same as
+ -- same as
\family typewriter
C-w
\family default
\family default
\family typewriter
-lyx-quit
+lyx-quit
\family default
---
+ --
\family typewriter
Alt-F4
\family default
\family default
\family typewriter
-font-default
+font-default
\family default
--- stop using any special font
+ -- stop using any special font
\end_layout
\begin_layout List
\family default
\family typewriter
-font-bold
+font-bold
\family default
--- make
+ -- make
\series bold
bold
\series default
\family default
\family typewriter
-font-emph
+font-emph
\family default
--- make
+ -- make
\emph on
emphasized
\emph default
\family default
\family typewriter
-font-code
+font-code
\family default
--- make
+ -- make
\family typewriter
typewritten
\family default
\family default
\family typewriter
-font-noun
+font-noun
\family default
--- make
+ -- make
\noun on
Caps/small caps
\noun default
\family typewriter
math-insert
\backslash
-prime
+prime
\family default
--- The
+ -- The
\begin_inset Quotes eld
\end_inset
\family typewriter
command-sequence math-superscript; math-insert
\backslash
-prime;
+prime;
\family default
--- Insert a prime as a superscript (see example above).
+ -- Insert a prime as a superscript (see example above).
\end_layout
\begin_layout List
\family default
\family typewriter
-math-insert ^
+math-insert ^
\family default
--- Insert an upper index.
+ -- Insert an upper index.
Also,
\family typewriter
^
\family default
\family typewriter
-math-insert _
+math-insert _
\family default
--- Insert a lower index.
+ -- Insert a lower index.
Also,
\family typewriter
_
\family typewriter
math-insert
\backslash
-partial
+partial
\family default
--- Partial derivative symbol
+ -- Partial derivative symbol
\begin_inset Formula $\partial$
\end_inset
\family typewriter
math-insert
\backslash
-sum
+sum
\family default
--- Summation symbol
+ -- Summation symbol
\begin_inset Formula $\sum$
\end_inset
\family typewriter
math-insert
\backslash
-infty
+infty
\family default
--- Infinity
+ -- Infinity
\begin_inset Formula $\infty$
\end_inset
\family typewriter
math-insert
\backslash
-times
+times
\family default
--- Cross product
+ -- Cross product
\begin_inset Formula $\times$
\end_inset
\family default
\family typewriter
-math-matrix 1 2
+math-matrix 1 2
\family default
--- Insert a stacked array
+ -- Insert a stacked array
\begin_inset Formula $\begin{array}{c}
\begin{array}{c}
\end{array}\end{array}$
\family default
\family typewriter
-math-matrix 3 3
+math-matrix 3 3
\family default
--- Insert a 3
+ -- Insert a 3
\begin_inset Formula $\times$
\end_inset
\family typewriter
math-insert
\backslash
-dagger
+dagger
\family default
--- The
+ -- The
\begin_inset Quotes eld
\end_inset
\family typewriter
math-insert
\backslash
-equiv
+equiv
\family default
---
+ --
\begin_inset Quotes eld
\end_inset
\family typewriter
math-insert
\backslash
-approx
+approx
\family default
---
+ --
\begin_inset Quotes eld
\end_inset
\family typewriter
math-insert
\backslash
-sim
+sim
\family default
--- The
+ -- The
\begin_inset Quotes eld
\end_inset
\family typewriter
math-insert
\backslash
-rightarrow
+rightarrow
\family default
--- The arrow
+ -- The arrow
\begin_inset Formula $\rightarrow$
\end_inset
\family typewriter
math-insert
\backslash
-leq
+leq
\family default
--- Less-or-equal
+ -- Less-or-equal
\begin_inset Formula $\leq$
\end_inset
\family typewriter
math-insert
\backslash
-geq
+geq
\family default
--- Greater-or-equal
+ -- Greater-or-equal
\begin_inset Formula $\geq$
\end_inset
\family typewriter
math-insert
\backslash
-ll
+ll
\family default
---
+ --
\begin_inset Quotes eld
\end_inset
\family typewriter
math-insert
\backslash
-gg
+gg
\family default
---
+ --
\begin_inset Quotes eld
\end_inset
\family sans
M-k\InsetSpace ~
-o
+o
+\family default
+
\family typewriter
keymap-off
\end_layout
\family sans
M-k\InsetSpace ~
-t
+t
+\family default
+
\family typewriter
keymap-toggle
\end_layout
\family sans
M-k\InsetSpace ~
-x
+x
+\family default
+
\family typewriter
keymap-off
\end_layout
\family sans
M-k\InsetSpace ~
-1
+1
+\family default
+
\family typewriter
keymap-primary
\end_layout
\family sans
M-k\InsetSpace ~
-2
+2
+\family default
+
\family typewriter
keymap-secondary
\end_layout
projects / lyx.git / blobdiff