#LyX 2.4 created this file. For more info see https://www.lyx.org/
-\lyxformat 608
+\lyxformat 620
\begin_document
\begin_header
\save_transient_properties true
\suppress_date false
\justification true
\use_refstyle 0
+\use_formatted_ref 0
\use_minted 0
\use_lineno 0
\notefontcolor #0000ff
\html_be_strict true
\docbook_table_output 0
\docbook_mathml_prefix 1
-\author -970929547 "Thibaut Cuvelier"
\author -712698321 "Jürgen Spitzmüller"
-\author -584632292 "Richard Kimberly Heck"
-\author -495245474 "Jean-Marc Lasgouttes"
-\author 5863208 "ab"
-\author 34634807 "Jean-Pierre"
-\author 232239728 "Owner"
-\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
-\author 1075283030 "Thibaut"
\end_header
\begin_body
\begin_layout Title
Customizing \SpecialChar LyX
-: Features for the Advanced User
+:
+ Features for the Advanced User
\end_layout
\begin_layout Author
status collapsed
\begin_layout Plain Layout
-If you have comments or error corrections, please send them to the \SpecialChar LyX
- Documentatio
-n mailing list,
+If you have comments or error corrections,
+ please send them to the \SpecialChar LyX
+ Documentation mailing list,
+
\begin_inset CommandInset href
LatexCommand href
target "lyx-docs@lists.lyx.org"
\begin_inset Quotes erd
\end_inset
- in the subject header, and please cc the current maintainer of this file,
- Richard
-\change_inserted 5863208 1604930692
-Kimberly
-\change_unchanged
-Heck <
-\change_inserted 5863208 1604930729
-rikiheck@lyx.org
-\change_deleted 5863208 1604930668
-rikiheck@lyx.org
-\change_unchanged
->.
+ in the subject header,
+ and please cc the current maintainer of this file,
+ Richard Kimberly Heck <rikiheck@lyx.org>.
\end_layout
\end_inset
\begin_layout Standard
\begin_inset Note Note
-status open
+status collapsed
\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.
+ 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
\begin_layout Standard
This manual covers the customization features present in \SpecialChar LyX
.
- In it, we discuss issues like keyboard shortcuts, screen previewing options,
- printer options, sending commands to \SpecialChar LyX
+ In it,
+ we discuss issues like keyboard shortcuts,
+ screen previewing options,
+ printer options,
+ sending commands to \SpecialChar LyX
via the \SpecialChar LyX
- Server, internationalization,
+ Server,
+ internationalization,
installing new \SpecialChar LaTeX
classes and \SpecialChar 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.
+ 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
status collapsed
\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 \SpecialChar LaTeX
+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 \SpecialChar LaTeX
output.
\end_layout
\begin_layout Standard
This chapter aims to help you to find your way through the \SpecialChar LyX
- configuration
- files.
- Before continuing to read this chapter, you should find out where your
- \SpecialChar LyX
- library and user directories are by using
+ configuration files.
+ Before continuing to read this chapter,
+ you should find out where your \SpecialChar LyX
+ system and user directories are by using
\begin_inset Flex Noun
status collapsed
\end_inset
.
- The library directory is the place where \SpecialChar LyX
- places its system-wide configuration
- files; the user directory is where you can place your modified versions.
+ The system directory is the place where \SpecialChar LyX
+ places its system-wide configuration files;
+ the user directory is where you can place your modified versions.
We will call the former
\begin_inset Flex Code
status collapsed
\end_inset
- and its sub-directories contain a number of files
-\change_deleted 232239728 1604787780
-and
-\change_unchanged
- that can be used to customize \SpecialChar LyX
+ and its sub-directories contain a number of files that can be used to customize \SpecialChar LyX
's behavior.
You can change many of these files from within \SpecialChar LyX
itself through the
dialog.
Most customization that you will want to do in \SpecialChar LyX
- is possible through this
- dialog.
- However, many other inner aspects of \SpecialChar LyX
- can be customized by modifying the
- files in
+ is possible through this dialog.
+ However,
+ many other inner aspects of \SpecialChar LyX
+ can be customized by modifying the files in
\begin_inset Flex Code
status collapsed
\end_inset
.
- These files fall in different categories, described in the following subsection
-s.
+ These files fall in different categories,
+ described in the following subsections.
\end_layout
\begin_layout Subsection
are generated when you configure \SpecialChar LyX
.
- They contain various default values that are
-\change_inserted 5863208 1604919565
-automatically detected during reconfiguration.
-\change_deleted 232239728 1604788241
-guessed by inspection
-\change_unchanged
- In general, it is not a good idea to modify them, since they might be overwritt
-en at any time.
+ They contain various default values that are automatically detected during reconfiguration.
+ In general,
+ it is not a good idea to modify them,
+ since they might be overwritten at any time.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 5863208 1604919950
-
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted 232239728 1604853928
-I capitalized the first word in all of these lists.
- To me it looks better but it really is a stylistic thing, your call.
- However if you are not going to capitalize them, the english in some needs
- to be modified to make it read correctly as a sentence.
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-
-\change_deleted 232239728 1604853510
-c
-\change_inserted 232239728 1604853510
-C
-\change_unchanged
-ontains defaults for various commands.
+ Contains defaults for various commands.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604853512
-c
-\change_inserted 232239728 1604853512
-C
-\change_unchanged
-ontains the list of packages that have been recognized by \SpecialChar LyX
+ Contains the list of packages that have been recognized by \SpecialChar LyX
.
It is currently unused by the \SpecialChar LyX
- program itself, but the information extracted,
- and more, is made available with
+ program itself,
+ but the information extracted,
+ and more,
+ is made available with
\begin_inset Flex Noun
status collapsed
\end_inset
-
-\change_deleted 232239728 1604853515
-t
-\change_inserted 232239728 1604853515
-T
-\change_unchanged
-he list of text classes that have been found in your
+ The list of text classes that have been found in your
\begin_inset Flex Code
status collapsed
\end_inset
- directories, along with the associated \SpecialChar LaTeX
+ directories,
+ along with the associated \SpecialChar LaTeX
document class and their description.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604853518
-t
-\change_inserted 232239728 1604853518
-T
-\change_unchanged
-he list of layout modules found in your
+ The list of layout modules found in your
\begin_inset Flex Code
status collapsed
\end_inset
-
-\change_deleted 232239728 1604853523
-l
-\change_inserted 232239728 1604853523
-L
-\change_unchanged
-ists of various sorts of \SpecialChar LaTeX
+ Lists of various sorts of \SpecialChar LaTeX
-related files found on your system
\end_layout
\end_layout
\begin_layout Standard
-The
-\change_deleted 5863208 1604928729
-se
-\change_unchanged
-
-\change_inserted 5863208 1604928636
-following
-\change_unchanged
-directories
-\change_inserted 5863208 1604928661
-in
-\change_unchanged
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LyXDir
-\end_layout
-
-\end_inset
-
-
-\change_inserted 5863208 1604928662
- can be
-\change_deleted 5863208 1604928642
-are
-\change_unchanged
- duplicated
-\change_deleted 5863208 1604928669
-between
+The following directories in
\begin_inset Flex Code
status collapsed
\end_inset
- and
-\change_inserted 5863208 1604928680
-in
-\change_unchanged
-
+ can be duplicated in
\begin_inset Flex Code
status collapsed
\end_inset
.
- If a particular file
-\change_deleted 232239728 1604794430
-s
-\change_unchanged
- exists in both places, the one in
+ If a particular file exists in both places,
+ the one in
\begin_inset Flex Code
status collapsed
\end_inset
-
-\change_deleted 232239728 1604794460
-t
-\change_inserted 232239728 1604794460
-T
-\change_unchanged
-his directory contains files with the extension
+ This directory contains files with the extension
\begin_inset Flex Code
status collapsed
that define the keybindings used in \SpecialChar LyX
.
- If there exists an internationalized version of the bind file named
+ If there exists an internationalized version of the bind file in a subdirectory
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$LANG_xxx.bind
+bind/xx
\end_layout
\end_inset
-, that will be used first.
+ where
+\begin_inset Quotes eld
+\end_inset
+
+xx
+\begin_inset Quotes erd
+\end_inset
+
+ is the ISO language code,
+ that will be used first.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604794478
-c
-\change_inserted 232239728 1604794478
-C
-\change_unchanged
-ontains files with the extension
+ Contains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- which define the diverse citation possibilities (natbib, biblatex etc.).
+ which define the diverse citation possibilities (natbib,
+ biblatex etc.).
See
\begin_inset CommandInset ref
LatexCommand ref
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604794483
-c
-\change_inserted 232239728 1604794486
-C
-\change_unchanged
-ontains graphics files that can be included in documents.
+ Contains graphics files that can be included in documents.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604794492
-c
-\change_inserted 232239728 1604794492
-C
-\change_unchanged
-ontains \SpecialChar LyX
+ Contains \SpecialChar LyX
documentation files (including the one you are currently reading).
The file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted 232239728 1604794660
-\SpecialChar LaTeX
-
-\change_inserted 232239728 1604794661
-LaTex
-\change_unchanged
-Config.lyx
+LaTexConfig.lyx
\end_layout
\end_inset
- deserves special attention, as noted above.
+ deserves special attention,
+ as noted above.
The internationalized help docs are in subdirectories
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Internationalizing-LyX"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604794497
-c
-\change_inserted 232239728 1604794497
-C
-\change_unchanged
-ontains example files that explain how to use some features.
- In the file browser, press the
+ Contains example files that explain how to use some features.
+ In the file browser,
+ press the
\begin_inset Flex Noun
status collapsed
\end_inset
-
-\change_deleted 232239728 1604794500
-c
-\change_inserted 232239728 1604794500
-C
-\change_unchanged
-ontains image files that are used by the
+ Contains image files that are used by the
\begin_inset Flex Noun
status collapsed
\end_inset
dialog.
- In addition, it also contains the individual icons used in the toolbar
- and the banners that can be shown when \SpecialChar LyX
+ In addition,
+ it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
is launched.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604794505
-c
-\change_inserted 232239728 1604794505
-C
-\change_unchanged
-ontains keyboard keymapping files.
+ Contains keyboard keymapping files.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:International-Keymap-Stuff"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604794508
-c
-\change_inserted 232239728 1604794508
-C
-\change_unchanged
-ontains the text class and module files described in
+ Contains the text class and module files described in
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Installing-New-Document"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604794513
-c
-\change_inserted 232239728 1604794513
-C
-\change_unchanged
-ontains the
+ Contains the
\begin_inset Flex Code
status collapsed
Python scripts used to convert between \SpecialChar LyX
versions.
- These can be run from the command line if
-\change_deleted 232239728 1604794749
-, say,
-\change_unchanged
- you want to batch-convert files.
+ These can be run from the command line if you want to batch-convert files.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604794516
-c
-\change_inserted 232239728 1604794516
-C
-\change_unchanged
-ontains some files that demonstrate the capabilities of the
+ Contains some files that demonstrate the capabilities of the
\begin_inset Flex Noun
status collapsed
\end_inset
-
-\change_deleted 232239728 1604794520
-c
-\change_inserted 232239728 1604794520
-C
-\change_unchanged
-ontains the standard \SpecialChar LyX
+ Contains the standard \SpecialChar LyX
template files described in
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Creating-Templates"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604794524
-c
-\change_inserted 232239728 1604794524
-C
-\change_unchanged
-ontains files with the extension
+ Contains files with the extension
\begin_inset Flex Code
status collapsed
that define the user interface to \SpecialChar LyX
.
- That is, the files define which items appear in which menus and the items
- appearing on the toolbar.
+ That is,
+ the files define which items appear in which menus and the items appearing on the toolbar.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604794528
-c
-\change_inserted 232239728 1604794528
-C
-\change_unchanged
-ontains files with the extension
+ Contains files with the extension
\begin_inset Flex Code
status collapsed
\end_inset
- which define the templates for the insertion of external material to a
- \SpecialChar LyX
- document; see
+ which define the templates for the insertion of external material to a \SpecialChar LyX
+ document;
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:Including-External-Material"
+nolink "false"
\end_inset
\begin_layout Standard
These files are used internally by \SpecialChar LyX
- and you generally do not need to modify
- them unless you are a developer.
+ and you generally do not need to modify them unless you are a developer.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604797616
-t
-\change_inserted 232239728 1604797616
-T
-\change_unchanged
-his file contains the list of \SpecialChar LyX
+ This file contains the list of \SpecialChar LyX
developers.
The contents are displayed with the menu entry
\begin_inset Flex Noun
\end_inset
-
-\change_deleted 232239728 1604797620
-t
-\change_inserted 232239728 1604797620
-T
-\change_unchanged
-his is a \SpecialChar LaTeX
+ This is a \SpecialChar LaTeX
script used during the configuration process.
Do not run directly.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604797624
-t
-\change_inserted 232239728 1604797624
-T
-\change_unchanged
-his is a Python script that is used to re-configure \SpecialChar LyX
+ This is a Python script that is used to re-configure \SpecialChar LyX
.
It creates configuration files in the directory it was run from.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604797580
-t
-\change_inserted 232239728 1604797580
-T
-\change_unchanged
-his 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
\end_inset
-
-\change_deleted 232239728 1604797584
-t
-\change_inserted 232239728 1604797584
-T
-\change_unchanged
-his file contains a list of all the languages currently supported by \SpecialChar LyX
+ This file contains a list of all the languages currently supported by \SpecialChar LyX
.
\end_layout
\end_inset
-
-\change_deleted 232239728 1604797587
-c
-\change_inserted 232239728 1604797587
-C
-\change_unchanged
-ontains information about the supported fonts.
+ Contains information about the supported fonts.
\end_layout
\begin_layout Labeling
\end_inset
-
-\change_deleted 232239728 1604797591
-t
-\change_inserted 232239728 1604797591
-T
-\change_unchanged
-his file contains translations for internationalized paragraph styles (see
-
+ This file contains translations for internationalized paragraph styles (see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
+nolink "false"
\end_inset
\end_inset
-
-\change_deleted 232239728 1604797594
-t
-\change_inserted 232239728 1604797594
-T
-\change_unchanged
-his file contains information about Unicode-encoded glyphs and the way they
- are supported by \SpecialChar LyX
+ This file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
via \SpecialChar LaTeX
.
\end_layout
\begin_layout Standard
Even if you are using \SpecialChar LyX
- as an unprivileged user, you might want to change
- \SpecialChar LyX
+ as an unprivileged user,
+ you might want to change \SpecialChar LyX
configuration for your own use.
The
\begin_inset Flex Code
\end_inset
-, which means that every file in
+,
+ which means that every file in
\begin_inset Flex Code
status collapsed
\end_inset
.
- Any configuration file described in the above sections can be placed either
- in the system-wide directory, in which case it will affect all users, or
- in your local directory for your own use.
+ Any configuration file described in the above sections can be placed either in the system-wide directory,
+ in which case it will affect all users,
+ or in your local directory for your own use.
\end_layout
\begin_layout Standard
-To make things clearer, let's provide a few examples:
+To make things clearer,
+ let's provide a few examples:
\end_layout
\begin_layout Itemize
\end_inset
-, \SpecialChar LyX
+,
+ \SpecialChar LyX
runs the
\begin_inset Flex Code
status collapsed
\end_inset
- script, and the resulting files are written in your local configuration
- directory.
- This means that any additional text class file that you might have added
- in
+ script,
+ and the resulting files are written in your local configuration directory.
+ This means that any additional text class file that you might have added in
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Itemize
-If you get some updated documentation from
-\change_inserted 232239728 1604798171
- a
-\change_unchanged
- \SpecialChar LyX
- ftp site and cannot install it because you do not have sysadmin rights
- on your system, you can just copy the files
-\change_deleted 232239728 1604798193
-in
-\change_inserted 232239728 1604798193
-to
-\change_unchanged
-
+If you get some updated documentation from a \SpecialChar LyX
+ ftp site and cannot install it because you do not have sysadmin rights on your system,
+ you can just copy the files to
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The configuration freedom of the local configuration directory may not suffice
- if you want to have more than one configuration at your disposal.
- For example, you may want to
-\change_deleted 232239728 1604798238
-be
-\change_unchanged
-use different key bindings or printer settings at different times.
+The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
+ For example,
+ you may want to use different key bindings or printer settings at different times.
You can achieve this by having several such directories.
You then specify which directory to use at run-time.
\end_layout
\emph on
<some directory>
\emph default
- instructs the program to read the configuration from that directory, and
- not from the default directory.
+ instructs the program to read the configuration from that directory,
+ and not from the default directory.
(You can determine the default directory by running \SpecialChar LyX
without the
\begin_inset Flex Code
\end_inset
- switch.) If the specified directory does not exist, \SpecialChar LyX
- offers to create it
- for you, just like it does for the default directory
-\change_deleted 232239728 1604798318
-on
-\change_unchanged
- the first time you run the program.
- You can modify the configuration options in this additional user directory
- exactly as you would for the default directory.
+ switch.) If the specified directory does not exist,
+ \SpecialChar LyX
+ offers to create it for you,
+ just like it does for the default directory the first time you run the program.
+ You can modify the configuration options in this additional user directory exactly as you would for the default directory.
These directories are completely independent (but read on).
Note that setting the environment variable
\begin_inset Flex Code
\end_layout
\begin_layout Standard
-Having several configurations also requires more maintenance: if you want
- to add a new layout to
+Having several configurations also requires more maintenance:
+ if you want to add a new layout to
\begin_inset Flex Code
status collapsed
\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 \SpecialChar LyX
- creates the additional
- 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.
+ 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 \SpecialChar LyX
+ creates the additional 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.
Take care with the
\begin_inset Flex 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 Noun
status collapsed
\end_inset
-) which is configuration
-\change_deleted 232239728 1604798083
--
-\change_inserted 232239728 1604798100
-
-\change_unchanged
-specific.
+) which is configuration specific.
\end_layout
\begin_layout Chapter
\begin_layout Standard
The first step is to define your file formats if they are not already defined.
- To do so, open the
+ To do so,
+ open the
\begin_inset Flex Noun
status collapsed
\end_inset
field is used to provide a keyboard shortcut on the menus.
- (For example, pressing
+ (For example,
+ pressing
\begin_inset Flex Noun
status collapsed
\end_inset
associated with it.
- For example, you might want to use
+ For example,
+ you might want to use
\begin_inset Flex Noun
status collapsed
\end_inset
to view PostScript files.
- You can enter the command needed to start the program in the corresponding
- fields.
- In defining this command, you can use the four variables listed in the
- next section.
+ You can enter the command needed to start the program in the corresponding fields.
+ In defining this command,
+ you can use the four variables listed in the next section.
The viewer is launched when you view an image in \SpecialChar LyX
or use the
\begin_inset Flex Noun
\end_inset
menu.
- The editor is for example launched when you right-click on an image and
- choose
+ The editor is for example launched when you right-click on an image and choose
\begin_inset Flex Noun
status collapsed
\end_inset
- type of a format is optional, but if it is specified, it must be unique
- across all formats.
+ type of a format is optional,
+ but if it is specified,
+ it must be unique across all formats.
It is used to detect files of this format from the file contents.
- For some important file formats there is no MIME type officially registered
- with the
+ For some important file formats there is no MIME type officially registered with the
\begin_inset CommandInset href
LatexCommand href
name "IANA"
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Converters"
+nolink "false"
\end_inset
-), the format will appear in the
+),
+ the format will appear in the
\begin_inset Flex Noun
status collapsed
\end_inset
menu if a viewer is specified for the format.
- Pure image formats, such as
+ Pure image formats,
+ such as
\begin_inset Flex Code
status collapsed
\end_inset
-, should not use this option.
+,
+ should not use this option.
Formats that can both represent vector graphics and documents like
\begin_inset Flex Code
status collapsed
tells \SpecialChar LyX
that a format can contain vector graphics.
- This information is used to determine the target format of included graphics
- for
+ This information is used to determine the target format of included graphics for
\begin_inset Flex Noun
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Noun
status collapsed
\end_inset
-, or
+,
+ or
\begin_inset Flex Noun
status collapsed
\end_inset
-, since
+,
+ since
\begin_inset Flex Noun
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Noun
status collapsed
\end_inset
-, or
+,
+ or
\begin_inset Flex Noun
status collapsed
\end_inset
- format, it is converted to
+ format,
+ it is converted to
\begin_inset Flex Noun
status collapsed
\end_inset
- if the vector format option is set, and otherwise to
+ if the vector format option is set,
+ and otherwise to
\begin_inset Flex Noun
status collapsed
\begin_layout Standard
Since all conversions from one format to another take place in \SpecialChar LyX
-'s temporary
- directory, it is sometimes necessary to modify a file before copying it
- to the temporary directory in order that the conversion may be performed.
+'s temporary directory,
+ it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-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.
+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
- This is done by a Copier: It copies a file to (or from) the temporary directory
- and may modify it in the process.
+ This is done by a Copier:
+ It copies a file to (or from) the temporary directory and may modify it in the process.
\end_layout
\begin_layout Standard
\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 Code
status collapsed
\end_inset
Save it in your local \SpecialChar LyX
- directory—say,
+ directory—
+say,
+
\begin_inset Flex Code
status collapsed
\end_inset
-—and make it executable, if you need to do so on your platform.
- Then, in the
+—
+and make it executable,
+ if you need to do so on your platform.
+ Then,
+ in the
\begin_inset Flex Noun
status collapsed
\end_inset
- dialog, select under
+ dialog,
+ select under
\begin_inset Flex Noun
status collapsed
\end_inset
- format—or one of the other pdf formats—and enter
+ format—
+or one of the other pdf formats—
+and enter
\begin_inset Flex Code
status collapsed
\begin_layout Standard
Copiers are used by \SpecialChar LyX
in various of its own conversions.
- For example, if appropriate programs are found, \SpecialChar LyX
- will automatically install
- copiers for the
+ For example,
+ if appropriate programs are found,
+ \SpecialChar LyX
+ will automatically install copiers for the
\begin_inset Flex Noun
status collapsed
\end_inset
formats.
- 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 \SpecialChar LyX
+ 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 \SpecialChar LyX
file was found.
\begin_inset Foot
status collapsed
\begin_inset Quotes erd
\end_inset
- argument takes a comma-separated list of extensions to be copied; if it
- is omitted, all files will be copied.
+ argument takes a comma-separated list of extensions to be copied;
+ if it is omitted,
+ all files will be copied.
The
\begin_inset Quotes eld
\end_inset
\end_inset
argument determines the extension added to the generated directory.
- By default, it is
+ By default,
+ it is
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, so HTML generated from
+,
+ so HTML generated from
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Standard
-To define a new converter, select the
+To define a new converter,
+ select the
\begin_inset Flex Noun
status collapsed
\end_inset
- from the drop-down lists, enter the command needed for the conversion,
+ from the drop-down lists,
+ enter the command needed for the conversion,
and then press the
\begin_inset Flex Noun
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g., without the extension)
+g.,
+ without the extension)
\end_layout
\begin_layout Labeling
\end_inset
- The path to the original input file (this is different from $$p when a
- chain of converters is called)
+ The path to the original input file (this is different from $$p when a chain of converters is called)
\end_layout
\begin_layout Labeling
\end_inset
- field you can enter the following flags, separated by commas:
+ field you can enter the following flags,
+ separated by commas:
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-latex
-\change_inserted -712698321 1524656940
-=flavor
-\change_unchanged
-
+latex=flavor
\end_layout
\end_inset
This will make \SpecialChar LyX
's \SpecialChar LaTeX
error logs available.
-
-\change_inserted -712698321 1524657018
The optional
\begin_inset Flex Code
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657012
flavor
-\change_unchanged
-
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657005
-latex, pdflatex, platex, xetex, luatex
-\change_unchanged
-
+latex,
+ pdflatex,
+ platex,
+ xetex,
+ luatex
\end_layout
\end_inset
).
- If no value is specified,
+ If no value is specified,
+
\begin_inset Flex Code
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657018
latex
-\change_unchanged
-
\end_layout
\end_inset
is used.
-\change_unchanged
-
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-needaux
-\change_inserted -712698321 1524656935
-=flavor
-\change_unchanged
+needauth
+\end_layout
+
+\end_inset
+
+ This converter is considered non-safe and needs authorization by the user.
+ Depending on the settings in
+\family sans
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+Converters
+\family default
+,
+ users will (a.) be asked whether they trust the current document temporarily,
+ permanently,
+ or not,
+ (b.) be informed that conversion is not possible due to security concerns,
+ or (c.) not be informed as they gave permanent consent.
+ Set this flag for converters that might execute arbitrary programs.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+needaux=flavor
\end_layout
\end_inset
\end_inset
file for the conversion.
-
-\change_inserted -712698321 1524657047
The optional
\begin_inset Flex Code
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657030
flavor
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657047
.aux
-\change_unchanged
-
\end_layout
\end_inset
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657030
-latex, pdflatex, platex, xetex, luatex
-\change_unchanged
-
+latex,
+ pdflatex,
+ platex,
+ xetex,
+ luatex
\end_layout
\end_inset
).
- If no value is specified,
+ If no value is specified,
+
\begin_inset Flex Code
status open
\begin_layout Plain Layout
-
-\change_inserted -712698321 1524657030
latex
-\change_unchanged
-
\end_layout
\end_inset
is used.
-\change_unchanged
-
\end_layout
\begin_layout Labeling
\begin_inset Quotes erd
\end_inset
- file from the backend, which in practice means a \SpecialChar LaTeX
- file like the one we
- would export, without
+ file from the backend,
+ which in practice means a \SpecialChar LaTeX
+ file like the one we would export,
+ without
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The following three flags are not really flags at all because they take
- an argument in the
+The following three flags are not really flags at all because they take an argument in the
\begin_inset Flex Noun
status collapsed
\begin_layout Labeling
\labelwidthstring 00.00.0000
-
-\change_inserted -712698321 1523206314
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523206193
hyperref-driver
-\change_unchanged
-
\end_layout
\end_inset
hyperref
\family default
package for this converter.
- The loading of the correct driver is necessary to get some PDF-specific
- features.
+ The loading of the correct driver is necessary to get some PDF-specific features.
See the
\family sans
hyperref
\end_inset
- If set, the converter's standard error will be redirected to a file
+ If set,
+ the converter's standard error will be redirected to a file
\begin_inset Flex Code
status collapsed
\end_inset
-, and the script given as argument will be run as:
+,
+ and the script given as argument will be run as:
+
\begin_inset Flex Code
status collapsed
\end_inset
- The name of the directory in which the converter will dump the generated
- files.
+ The name of the directory in which the converter will dump the generated files.
\SpecialChar LyX
- will not create this directory, and it does not copy anything into it,
+ 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
\begin_inset Flex Code
\end_inset
-, which will be replaced by the base name of the input and output files,
- respectively, when the directory is copied.
+,
+ which will be replaced by the base name of the input and output files,
+ respectively,
+ when the directory is copied.
\begin_inset Newline newline
\end_inset
\end_inset
- Determines the output file name and may, contain
+ Determines the output file name and may,
+ contain
\begin_inset Flex Code
status collapsed
\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
-
-\change_inserted -712698321 1523206384
-A suitable hyperref-driver is set for some converters that are installed
- with \SpecialChar LyX
-.
-
-\change_deleted -712698321 1523206388
-None of these
-\change_inserted -712698321 1523206389
-The
-\change_unchanged
- last three
-\change_inserted -712698321 1523206400
- flags, however,
-\change_unchanged
- are presently
-\change_inserted -712698321 1523206407
-not
-\change_unchanged
-used in any of the
-\change_inserted -712698321 1523206437
-pre-installed
-\change_unchanged
-converters
-\change_deleted -712698321 1523206442
- that are installed with \SpecialChar LyX
-
-\change_unchanged
+A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
.
-
+ The last three flags,
+ however,
+ are presently not used in any of the pre-installed converters.
\end_layout
\begin_layout Standard
-You do not have to define converters for all formats between which you want
- to convert.
- For example, you will note that there is no `\SpecialChar LyX
+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 `\SpecialChar LyX
to PostScript' converter,
but \SpecialChar LyX
will export PostScript.
It does so by first creating a \SpecialChar LaTeX
- file (no converter needs to be defined
- for this) which is then converted to DVI using the `\SpecialChar LaTeX
+ file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
to DVI' converter,
and finally converting the resulting DVI file to PostScript.
\SpecialChar 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 \SpecialChar LyX
- configuration provides five ways to convert
- \SpecialChar LaTeX
+ 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 \SpecialChar LyX
+ configuration provides five ways to convert \SpecialChar LaTeX
to PDF:
\end_layout
\begin_layout Enumerate
-Directly, using
+Directly,
+ using
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Enumerate
-via (DVI and) PostScript, using
+via (DVI and) PostScript,
+ using
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Enumerate
-via DVI, using
+via DVI,
+ using
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Standard
-To define such alternate chains, you must define multiple target `file formats',
+To define such alternate chains,
+ you must define multiple target `file formats',
as described in
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
+nolink "false"
\end_inset
.
- For example, in the standard configuration, the formats named
+ For example,
+ in the standard configuration,
+ the formats named
\begin_inset Flex Noun
status collapsed
\end_inset
-),
+),
+
\begin_inset Flex Noun
status collapsed
\end_inset
-),
+),
+
\begin_inset Flex Noun
status collapsed
\end_inset
-),
+),
+
\begin_inset Flex Noun
status collapsed
\end_inset
-), and
+),
+ and
\begin_inset Flex Noun
status collapsed
\end_inset
-) are defined, all of which share the extension
+) are defined,
+ all of which share the extension
\begin_inset Flex Noun
status collapsed
\end_inset
-, and which correspond to the conversion methods just mentioned.
+,
+ and which correspond to the conversion methods just mentioned.
\end_layout
\begin_layout Chapter
\begin_layout Standard
\SpecialChar LyX
supports using a translated interface.
- Last time we checked, \SpecialChar LyX
+ Last time we checked,
+ \SpecialChar LyX
provided text in thirty languages.
The language of choice is called your
\emph on
locale
\emph default
.
- (For further reading on locale settings, see also the documentation for
- locale that comes with your operating system.
- For Linux, the manual page for
+ (For further reading on locale settings,
+ see also the documentation for locale that comes with your operating system.
+ For Linux,
+ the manual page for
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-Notice that these translations will work, but do contain a few flaws.
- In particular, all dialogs have been designed with the English text in
- mind, which means that some of the translated text will be too large to
- fit within the space allocated.
+Notice that these translations will work,
+ but do contain a few flaws.
+ In particular,
+ all dialogs have been designed with the English text in mind,
+ which means that some of the translated text will be too large to fit within the space allocated.
This is only a display problem and will not cause any harm.
- Also, you will find that some of the translations do not define shortcut
- keys for everything.
- Sometimes, there are simply not enough free letters to do it.
- Other times, the translator just hasn't got around to doing it yet.
- Our localization team, which you may wish to join,
+ Also,
+ you will find that some of the translations do not define shortcut keys for everything.
+ Sometimes,
+ there are simply not enough free letters to do it.
+ Other times,
+ the translator just hasn't got around to doing it yet.
+ Our localization team,
+ which you may wish to join,
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-If you are a fluent speaker of a language other than English, joining these
- teams is a great way to give back to the \SpecialChar LyX
+If you are a fluent speaker of a language other than English,
+ joining these teams is a great way to give back to the \SpecialChar LyX
community!
\end_layout
library to handle the internationalization of the interface.
To have \SpecialChar LyX
- speak your favorite language in all menus and dialogs, you need
- a
+ speak your favorite language in all menus and dialogs,
+ you need a
\begin_inset Flex Code
status collapsed
\end_inset
-file for that language.
- When this is available, you'll have to generate a
+ When this is available,
+ you'll have to generate a
\begin_inset Flex Code
status collapsed
\end_inset
-file.
- The process of doing all of this is explained in the documentation for
- GNU
+ The process of doing all of this is explained in the documentation for GNU
\begin_inset Flex Code
status collapsed
\end_inset
.
- 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 \SpecialChar LyX
+ 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 \SpecialChar LyX
community.
Send a message to the \SpecialChar LyX
- developers' list for more information about how
- to proceed.
+ developers' list for more information about how to proceed.
\end_layout
\begin_layout Standard
-In short, this is what you should do (xx denotes the language code):
+In short,
+ this is what you should do (xx denotes the language code):
\end_layout
\begin_layout Itemize
\end_inset
- doesn't exist anywhere, it can be remade with the console command
+ doesn't exist anywhere,
+ it can be remade with the console command
\begin_inset Flex Code
status collapsed
\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
-This is just a text file, so it can be edited in any text editor.
- But there are also specialized programs that support such editing, such
- as
+This is just a text file,
+ so it can be edited in any text editor.
+ But there are also specialized programs that support such editing,
+ such as
\family typewriter
Poedit
\family default
\end_inset
- files, as well, see
+ files,
+ as well,
+ see
\begin_inset Flex URL
status open
\end_inset
- For some menu- and widget-labels, there are also shortcut keys that should
- be translated.
- Those keys are marked after a `|', and should be translated according to
- the words and phrases of the language.
- You should also fill also out the information at the beginning of the new
-
+ For some menu- and widget-labels,
+ there are also shortcut keys that should be translated.
+ Those keys are marked after a `|',
+ and should be translated according to the words and phrases of the language.
+ You should also fill also out the information at the beginning of the new
\begin_inset Flex Code
status collapsed
\end_inset
--file with your email-address, etc., so people know where to reach you with
- suggestions and entertaining flames.
+-file with your email-address,
+ etc.,
+ so people know where to reach you with suggestions and entertaining flames.
\end_layout
\begin_layout Standard
-If you are just doing this on your own, then:
+If you are just doing this on your own,
+ then:
\end_layout
\begin_layout Itemize
\end_inset
--file to your locale-tree, at the correct directory for application messages
- for the language
+-file to your locale-tree,
+ at the correct directory for application messages for the language
\series bold
\series default
-xx, and under the name
+xx,
+ and under the name
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-As said, however, it would be best if the new
+As said,
+ however,
+ it would be best if the new
\begin_inset Flex Code
status collapsed
\end_inset
file could be added to the \SpecialChar LyX
- distribution, so others can use it.
+ distribution,
+ so others can use it.
Adding it involves making additional changes to \SpecialChar 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
\end_layout
\begin_layout Standard
-Sometimes it turns out that one English message needs to be translated into
- different messages in the target language.
+Sometimes it turns out that one English message needs to be translated into different messages in the target language.
One example is the message
\begin_inset Flex Code
status collapsed
\lang german
Bis
\lang english
-, depending upon exactly what the English
+,
+ depending upon exactly what the English
\begin_inset Quotes eld
\end_inset
\end_inset
does not handle such ambiguous translations.
- Therefore you have to add some context information to the message: Instead
- of
+ Therefore you have to add some context information to the message:
+ Instead of
\begin_inset Flex Code
status collapsed
\lang german
Bis
\lang english
-, respectively.
+,
+ respectively.
\end_layout
\begin_layout Standard
-Of course the context information needs to be stripped off the original
- message when no translation is used.
- Therefore you have to put it in double square brackets at the end of the
- message (see the example above).
+Of course the context information needs to be stripped off the original message when no translation is used.
+ Therefore you have to put it in double square brackets at the end of the message (see the example above).
The translation mechanism of \SpecialChar LyX
- ensures that everything in double square
- brackets at the end of messages is removed before displaying the message.
+ ensures that everything in double square brackets at the end of messages is removed before displaying the message.
\end_layout
\begin_layout Subsection
status collapsed
\begin_layout Plain Layout
-As of March 2008, at least some of the documents have been translated into
- fourteen languages, with the Tutorial available in a few more.
+As of March 2008,
+ at least some of the documents have been translated into fourteen languages,
+ with the Tutorial available in a few more.
\end_layout
\end_inset
- and the locale is set accordingly, these will be used automagically by
- \SpecialChar LyX
+ and the locale is set accordingly,
+ these will be used automagically by \SpecialChar LyX
.
\SpecialChar LyX
looks for translated versions as
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
is the code for the language currently in use.
- If there are no translated documents, the default English versions will
- be displayed.
+ If there are no translated documents,
+ the default English versions will be displayed.
Note that the translated versions must have the same filenames (
\begin_inset Flex Code
status collapsed
\end_inset
above) as the original.
- If you feel up to translating the documentation (an excellent way to proof-read
- the original documentation by the way!), there are a few things you should
- do right away:
+ If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
+ there are a few things you should do right away:
\end_layout
\begin_layout Itemize
\end_inset
.
- That way, you can find out which (if any) documents have already been translate
-d into your language.
- You can also find out who (if anyone) is organizing the effort to translate
- the documentation into your language.
- If no one is organizing the effort, please let us know that you're interested.
+ That way,
+ you can find out which (if any) documents have already been translated into your language.
+ You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
+ If no one is organizing the effort,
+ please let us know that you're interested.
\end_layout
\begin_layout Standard
-Once you get to actually translating, here's a few hints for you that may
- save you trouble:
+Once you get to actually translating,
+ here's a few hints for you that may save you trouble:
\end_layout
\begin_layout Itemize
-Join the documentation team! There is information on how to do that in
+Join the documentation team!
+ There is information on how to do that in
\begin_inset Flex Code
status collapsed
\end_inset
-), which by the way is the first document you should translate.
+),
+ which by the way is the first document you should translate.
\end_layout
\begin_layout Itemize
Learn the typographic conventions for the language you are translating to.
- Typography is an ancient art and over the centuries, a great variety of
- conventions have developed throughout different parts of the world.
+ Typography is an ancient art and over the centuries,
+ a great variety of conventions have developed throughout different parts of the world.
Also study the professional terminology amongst typographers in your country.
Inventing your own terminology will only confuse the users.
\emph on
-(Warning! Typography is addictive!)
+(Warning!
+ Typography is addictive!)
\end_layout
\begin_layout Itemize
Make a copy of the document.
This will be your working copy.
- You can use this as your personal translated help-file by placing it in
- your
+ You can use this as your personal translated help-file by placing it in your
\begin_inset Flex Code
status collapsed
\series bold
Note:
+
\series default
- For a complex document with external material (images, etc.), if you make
- a copy e.
+ For a complex document with external material (images,
+ etc.),
+ if you make a copy e.
\begin_inset space \thinspace{}
\end_inset
\begin_inset space \space{}
\end_inset
-in a temp dir, beware that the links to external material may be broken
- when the document is moved to a different place.
+in a temp dir,
+ beware that the links to external material may be broken when the document is moved to a different place.
The best way is to retrieve the \SpecialChar LyX
tree from git (see
\begin_inset Flex URL
\end_inset
to see what has been changed.
- That way you can easily see which parts of the translated document need
- to be updated.
+ That way you can easily see which parts of the translated document need to be updated.
\end_layout
\begin_layout Standard
-If you ever find an error in the original document, fix it and notify the
- rest of the documentation team of the changes! (You didn't forget to join
- the documentation team, did you?)
+If you ever find an error in the original document,
+ fix it and notify the rest of the documentation team of the changes!
+ (You didn't forget to join the documentation team,
+ did you?)
\end_layout
\begin_layout Standard
\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
Ivan Schreter
\shape default
.
- It needs to be fixed to conform to the new Documentation Style sheet and
- to make use of the new v1.0 features.
- The whole thing also needs to be merged with the section following it.-jw
- It may also be badly out of date.-rh (2008)]
+ It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
+ The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
\end_layout
\begin_layout Subsection
-Defining Own Keymaps: Keymap File Format
+Defining Own Keymaps:
+ Keymap File Format
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-To define key-to-key or key-to-string translation, use this command:
+To define key-to-key or key-to-string translation,
+ use this command:
\end_layout
\begin_layout Quotation
\end_inset
is the string to be inserted into the document.
- To define dead keys, use:
+ To define dead keys,
+ use:
\end_layout
\begin_layout Quotation
\end_layout
\begin_layout Standard
-Since in many international keyboards there are exceptions to what some
- dead keys should do, you can define them using
+Since in many international keyboards there are exceptions to what some dead keys should do,
+ you can define them using
\end_layout
\begin_layout Quotation
\end_layout
\begin_layout Standard
-For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
-, so you put in
+For example,
+ on Slovak keyboard,
+ if you enter caron-o,
+ it generates circumflex-o,
+ so you put in
\end_layout
\begin_layout Quotation
\begin_layout Standard
to make it work correctly.
- Also, you have to define as exceptions dead keys over i and j, to remove
- the dot from them before inserting an accent mark.
- I will change this when the time comes, but so far I haven't had time.
+ Also,
+ you have to define as exceptions dead keys over i and j,
+ to remove the dot from them before inserting an accent mark.
+ I will change this when the time comes,
+ but so far I haven't had time.
\end_layout
\begin_layout Standard
-Oh, and about characters: backslash is escaped, so to enter it, you'll need
- double backslash.
- Also, quotes and
+Oh,
+ and about characters:
+ backslash is escaped,
+ so to enter it,
+ you'll need double backslash.
+ Also,
+ quotes and
\begin_inset Flex Code
status collapsed
\end_inset
- marks comments, quotes start and end \SpecialChar LaTeX
+ marks comments,
+ quotes start and end \SpecialChar LaTeX
-style commands.
- To enter quote, you'll need to use
+ To enter quote,
+ you'll need to use
\begin_inset Flex Code
status collapsed
\end_inset
-, to enter
+,
+ to enter
\begin_inset Flex Code
status collapsed
\end_inset
-, use
+,
+ use
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-If you make a keyboard description file that works for your language, please
- mail it to me, so I can include it in the next keymap distribution.
+If you make a keyboard description file that works for your language,
+ please mail it to me,
+ so I can include it in the next keymap distribution.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Also, it should look into
+Also,
+ it should look into
\begin_inset Flex Code
status collapsed
\end_inset
- file for defaults, too (for example, a
+ file for defaults,
+ too (for example,
+ a
\begin_inset Flex Code
status collapsed
status open
\begin_layout Plain Layout
-In doing the revisions on this document in March 2008, I did not look over
- this stuff, as I do not understand it.
+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
file syntax in detail.
- These sections should help you design your own key map if the ones provided
- do not meet your needs.
+ These sections should help you design your own key map if the ones provided do not meet your needs.
\end_layout
\begin_layout Subsection
\end_inset
file maps keystrokes to characters or strings.
- As the name suggests, it sets a keyboard mapping.
+ As the name suggests,
+ it sets a keyboard mapping.
The
\begin_inset Flex Code
status collapsed
\shape default
,
+
\shape up
\shape default
\end_inset
,
+
\shape up
\shape default
\end_inset
-, and
+,
+ and
\begin_inset Flex Code
status collapsed
string
\emph default
,
+
\family default
\family roman
dead key
\family default
\emph default
- refers to a key that does not produce a character by itself, but when followed
- with another key, produces the desired accent character.
- For example, a German characte
+ refers to a key that does not produce a character by itself,
+ but when followed with another key,
+ produces the desired accent character.
+ For example,
+ a German characte
\family roman
r with an umlaut like
\family default
\emph on
allowed
\emph default
-, you will get a
+,
+ you will get a
\family default
\family roman
\emph default
\family roman
-followed by the other, not allowed key, as output.
+followed by the other,
+ not allowed key,
+ as output.
\family default
Note that a
\end_inset
- cancels a dead key, so if
+ cancels a dead key,
+ so if
\family roman
you hit
\family default
\end_inset
-, the cursor will not go one position backwards but will instead cancel
- the effect t
+,
+ the cursor will not go one position backwards but will instead cancel the effect t
\family roman
hat
\family default
\begin_layout Standard
The following example specifies that the character ' is to be an acute accent,
- allowed on the characters a, e, i, o, u, A, E, I, O, and U:
+ allowed on the characters a,
+ e,
+ i,
+ o,
+ u,
+ A,
+ E,
+ I,
+ O,
+ and U:
\end_layout
\begin_layout LyX-Code
\family roman
\shape up
sequence,
+
\family default
\shape default
\emph on
accent char
\emph default
-, you get
+,
+ you get
\family default
\family roman
\end_layout
\begin_layout Standard
-The following command produces causes äi to be produced when you enter acute-i
- ('i):
+The following command produces causes äi to be produced when you enter acute-i ('i):
\end_layout
\begin_layout LyX-Code
\begin_layout LyX-Code
\backslash
-kmod ; acute aeioyvhAEIOYVH
+kmod ;
+ acute aeioyvhAEIOYVH
\backslash
-kmod : umlaut iyIY
+kmod :
+ umlaut iyIY
\backslash
kcomb acute umlaut iyIY
\end_layout
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
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\shape up
-;: Backspace i
+;:
+ Backspace i
\end_layout
\end_inset
\end_inset
- mapping is performed, a
+ mapping is performed,
+ a
\begin_inset Flex Code
status collapsed
\end_inset
- file maps the strings that the symbols generate to characters in the current
- font.
+ file maps the strings that the symbols generate to characters in the current font.
The \SpecialChar LyX
distribution currently includes at least the
\begin_inset Flex Code
\end_layout
\begin_layout Standard
-For example, in order to map
+For example,
+ in order to map
\begin_inset Flex Noun
status collapsed
\end_inset
- to the corresponding character in the iso-8859-1 set (233), the following
- declaration is used
+ to the corresponding character in the iso-8859-1 set (233),
+ the following declaration is used
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
If \SpecialChar LyX
- cannot find a mapping for the string produced by the keystroke or a
- deadkey sequence, it will check if it looks like an accented char and try
- to draw an accent over the character on screen.
+ cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
+ it will check if it looks like an accented char and try to draw an accent over the character on screen.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-There is a second way to add support for international characters through
- so-called dead-keys.
+There is a second way to add support for international characters through so-called dead-keys.
A dead-key works in combination with a letter to produce an accented character.
- Here, we'll explain how to create a really simple dead-key to illustrate
- how they work.
+ Here,
+ we'll explain how to create a really simple dead-key to illustrate how they work.
\end_layout
\begin_layout Standard
-Suppose you happen to need the circumflex character,
+Suppose you happen to need the circumflex character,
+
\begin_inset Quotes eld
\end_inset
\end_inset
file.
- Now, whenever you type the
+ Now,
+ whenever you type the
\begin_inset Flex Noun
status collapsed
\end_inset
--key followed by a letter, that letter will have a circumflex accent on
- it.
- For example, the sequence
+-key followed by a letter,
+ that letter will have a circumflex accent on it.
+ For example,
+ the sequence
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- produces the letter:
+ produces the letter:
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, however, \SpecialChar LyX
- will complain with a beep, since a
+,
+ however,
+ \SpecialChar LyX
+ will complain with a beep,
+ since a
\begin_inset Quotes eld
\end_inset
\end_inset
after a dead-key produces the bare-accent.
- Please note this last point! If you bind a key to a dead-key, you'll need
- to rebind the character on that key to yet another key.
+ Please note this last point!
+ If you bind a key to a dead-key,
+ you'll need to rebind the character on that key to yet another key.
Binding the
\begin_inset Flex Noun
status collapsed
\end_inset
- to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
+ to a cedilla is a bad idea,
+ since you'll only get cedillas instead of commas.
\end_layout
\begin_layout Standard
\end_inset
-,
+,
+
\begin_inset Flex Noun
status collapsed
\end_inset
-, and
+,
+ and
\begin_inset Flex Noun
status collapsed
\end_inset
- in combination with an accent, like
+ in combination with an accent,
+ like
\begin_inset Quotes eld
\end_inset
\end_inset
and permits you to bind keys to accented characters.
- You can also turn keys into dead-keys by binding them to something like
-
+ You can also turn keys into dead-keys by binding them to something like
\begin_inset Flex Code
status collapsed
\noun on
John Weiss
\noun default
-: This is exactly what I do in my
+:
+ This is exactly what I do in my
\begin_inset Flex Code
status collapsed
\end_inset
- key: One of the
+ key:
+ One of the
\begin_inset Flex Noun
status collapsed
\end_inset
- keys, a spare function key, etc.
+ keys,
+ a spare function key,
+ etc.
As for the \SpecialChar LyX
- commands that produce accents, check the entry for
+ commands that produce accents,
+ check the entry for
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-You can edit your preferences so that your desired language environment
- is automatically configured when \SpecialChar LyX
- starts up, via the
+You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
+ starts up,
+ via the
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Chapter
-
-\change_inserted -584632292 1610232084
-Creating and
-\change_unchanged
-Installing New Document Classes, Layouts, and Templates
+Creating and Installing New Document Classes,
+ Layouts,
+ and Templates
\begin_inset CommandInset label
LatexCommand label
name "cha:Installing-New-Document"
\end_layout
\begin_layout Standard
-In this chapter, we describe the procedures for creating and installing
- new \SpecialChar LyX
- layout and template files, as well as offer a refresher on correctly
- installing new \SpecialChar LaTeX
+In this chapter,
+ we describe the procedures for creating and installing new \SpecialChar LyX
+ layout and template files,
+ as well as offer a refresher on correctly installing new \SpecialChar LaTeX
document classes.
\end_layout
\begin_layout Standard
-First, let us a say a few words about how one ought to think about the relation
- between \SpecialChar LyX
+First,
+ let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
and \SpecialChar LaTeX
.
- The thing to understand is that, in a certain sense, \SpecialChar LyX
- doesn't know anything
- about \SpecialChar LaTeX
+ The thing to understand is that,
+ in a certain sense,
+ \SpecialChar LyX
+ doesn't know anything about \SpecialChar LaTeX
.
- Indeed, from \SpecialChar LyX
-'s point of view, \SpecialChar LaTeX
+ Indeed,
+ from \SpecialChar LyX
+'s point of view,
+ \SpecialChar LaTeX
is just one of several
\begin_inset Quotes eld
\end_inset
\end_inset
in which it is capable of producing output.
- Other such formats are DocBook, plaintext, and XHTML.
+ Other such formats are DocBook,
+ plaintext,
+ and XHTML.
\SpecialChar LaTeX
- is, of course, a particularly important format, but very little of the
- information \SpecialChar LyX
+ is,
+ of course,
+ a particularly important format,
+ but very little of the information \SpecialChar LyX
has about \SpecialChar LaTeX
is actually contained in the program itself.
\begin_inset Foot
\end_inset
- Rather, that information, even for the standard classes like
+ Rather,
+ that information,
+ even for the standard classes like
\begin_inset Flex Code
status collapsed
\end_inset
-, is contained in `layout files'.
- Similarly, \SpecialChar LyX
+,
+ is contained in `layout files'.
+ Similarly,
+ \SpecialChar LyX
itself does not know much about DocBook or XHTML.
What it knows is contained in layout files.
\end_layout
\begin_layout Standard
-You can think of the layout file for a given document class as a translation
- manual between \SpecialChar LyX
- constructs—paragraphs with their corresponding styles,
- certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
-, DocBook, or XHTML
- constructs.
+You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
+ constructs—
+paragraphs with their corresponding styles,
+ certain sorts of insets,
+ etc—
+and the corresponding \SpecialChar LaTeX
+,
+ DocBook,
+ or XHTML constructs.
Almost everything \SpecialChar LyX
knows about
\begin_inset Flex Code
\end_inset
-, for example, is contained in the file
+,
+ for example,
+ is contained in the file
\begin_inset Flex Code
status collapsed
\end_inset
and in various other files it includes.
- For this reason, anyone intending to write layout files should plan to
- study the existing files.
+ For this reason,
+ anyone intending to write layout files should plan to study the existing files.
A good place to start is with
\begin_inset Flex Code
status collapsed
\end_inset
-, which is included in
+,
+ which is included in
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, and many of the other layout files for document classes.
- This file is where sections and the like are defined:
+,
+ and many of the other layout files for document classes.
+ This file is where sections and the like are defined:
+
\begin_inset Flex Code
status collapsed
\end_inset
tells \SpecialChar LyX
- how paragraphs that are marked with the Section, Subsection, etc,
+ how paragraphs that are marked with the Section,
+ Subsection,
+ etc,
styles can be translated into corresponding \SpecialChar LaTeX
-, DocBook, and XHTML commands
- and tags.
+,
+ DocBook,
+ and XHTML commands and tags.
The
\begin_inset Flex Code
status collapsed
\begin_layout Standard
Defining the \SpecialChar LyX
–\SpecialChar LaTeX
- correspondence is not the only thing layout files do, though.
+ correspondence is not the only thing layout files do,
+ though.
Their other job is to define how the \SpecialChar LyX
- constructs themselves will appear
- on-screen.
+ constructs themselves will appear on-screen.
The fact that layout files have these two jobs is often a source of confusion,
because they are completely separate.
Telling \SpecialChar LyX
how to translate a certain paragraph style into \SpecialChar LaTeX
- does not tell
- \SpecialChar LyX
- how to display it; conversely, telling \SpecialChar LyX
- how to display a certain paragraph
- style does not tell \SpecialChar LyX
+ does not tell \SpecialChar LyX
+ how to display it;
+ conversely,
+ telling \SpecialChar LyX
+ how to display a certain paragraph style does not tell \SpecialChar LyX
how to translate it into \SpecialChar LaTeX
(let alone tell \SpecialChar LaTeX
- how to
- display it).
- So, in general, when you define a new \SpecialChar LyX
- construct, you must always do two
- quite separate things: (i)
+ how to display it).
+ So,
+ in general,
+ when you define a new \SpecialChar LyX
+ construct,
+ you must always do two quite separate things:
+ (i)
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-Much the same is true, of course, as regards \SpecialChar LyX
-'s other backend formats, though
- XHTML is in some ways different, because in that case \SpecialChar LyX
+Much the same is true,
+ of course,
+ as regards \SpecialChar LyX
+'s other backend formats,
+ though XHTML is in some ways different,
+ because in that case \SpecialChar LyX
\emph on
is
\emph default
- able, to some extent, to use information about how it should display a
- paragraph on the screen to output information (in the form of CSS) about
- how the paragraph should be displayed in a browser.
- Even in this case, however, the distinction between what \SpecialChar LyX
- does internally
- and how things are rendered externally remains in force, and the two can
- be controlled separately.
+ able,
+ to some extent,
+ to use information about how it should display a paragraph on the screen to output information (in the form of CSS) about how the paragraph should be displayed in a browser.
+ Even in this case,
+ however,
+ the distinction between what \SpecialChar LyX
+ does internally and how things are rendered externally remains in force,
+ and the two can be controlled separately.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Tags-for-XHTML"
+nolink "false"
\end_inset
\begin_layout Standard
Some installations may not include a \SpecialChar LaTeX
- package or class file that you would
- like to use within \SpecialChar LyX
+ package or class file that you would like to use within \SpecialChar LyX
.
- For example, you might need Foil\SpecialChar TeX
-, a package for preparing slides for overhead
- projectors.
+ For example,
+ you might need Foil\SpecialChar TeX
+,
+ a package for preparing slides for overhead projectors.
Modern \SpecialChar LaTeX
distributions like \SpecialChar TeX
Live (2008 or newer) or MiK\SpecialChar TeX
- provide a user interface
- for installing such packages.
- For example, with MiK\SpecialChar TeX
-, you start the program
+ provide a user interface for installing such packages.
+ For example,
+ with MiK\SpecialChar TeX
+,
+ you start the program
\begin_inset Quotes eld
\end_inset
\end_inset
to get a list of available packages.
- To install one of them, right click on it or use the corresponding toolbar
- button.
+ To install one of them,
+ right click on it or use the corresponding toolbar button.
\end_layout
\begin_layout Standard
If your \SpecialChar LaTeX
- distribution does not provide such a `package manager', or if the
- package is not available from your distribution, then follow these steps
- to install it manually:
+ distribution does not provide such a `package manager',
+ or if the package is not available from your distribution,
+ then follow these steps to install it manually:
\end_layout
\begin_layout Enumerate
\end_inset
(is the case for Foil\SpecialChar TeX
-) then open a console, change to the folder of this
- file and execute the command
+) then open a console,
+ change to the folder of this file and execute the command
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Enumerate
-Now you need to decide if the package should be available for all users
- or only for you.
+Now you need to decide if the package should be available for all users or only for you.
\end_layout
\begin_deeper
\begin_layout Enumerate
-On *nix systems (Linux, OSX, etc.), if you want the new package to be available
- for all users on your system, then install it in your `local' \SpecialChar TeX
- tree, otherwise
- install it in your own `user' \SpecialChar TeX
+On *nix systems (Linux,
+ OSX,
+ etc.),
+ if you want the new package to be available for all users on your system,
+ then install it in your `local' \SpecialChar TeX
+ tree,
+ otherwise install it in your own `user' \SpecialChar TeX
tree.
- Where these trees should be created, if they do not already exist, depends
- on your system.
- To find this out, look in the file
+ Where these trees should be created,
+ if they do not already exist,
+ depends on your system.
+ To find this out,
+ look in the file
\begin_inset Flex Code
status collapsed
\end_inset
-, though you can execute the command
+,
+ though you can execute the command
\begin_inset Flex Code
status collapsed
\end_inset
- variable; this is usually somewhere like
+ variable;
+ this is usually somewhere like
\begin_inset Flex Code
status collapsed
\end_inset
or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
-Live
- distribution.
+Live distribution.
The location of the `user' \SpecialChar TeX
tree is defined by
\begin_inset Flex Code
\end_inset
.
- (If these variables are not predefined, you have to define them.) You'll
- probably need root permissions to create or modify the `local' tree, but
- not for your `user' tree.
+ (If these variables are not predefined,
+ you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
+ but not for your `user' tree.
\begin_inset Newline newline
\end_inset
-In general, it is recommended to install in the user tree because your user
- will not be modified or even overwritten when you upgrade your system.
- It will typically also be backed up together with everything else when
- you backup your home directory (which, of course, you do on a regular basis).
+In general,
+ it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
+ It will typically also be backed up together with everything else when you backup your home directory (which,
+ of course,
+ you do on a regular basis).
\end_layout
\begin_layout Enumerate
-On Windows, if you want the new package to be available for all users on
- your system, change to the folder where \SpecialChar LaTeX
- is installed and then change to
- the subfolder
+On Windows,
+ if you want the new package to be available for all users on your system,
+ change to the folder where \SpecialChar LaTeX
+ is installed and then change to the subfolder
\begin_inset Flex Code
status collapsed
.
(For MiK\SpecialChar TeX
-, this would be by default the folder
+,
+ this would be by default the folder
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Note that this will be the correct path only on English installations.
- On a German one, it would be
+ On a German one,
+ it would be
\begin_inset Flex Code
status collapsed
\end_inset
-, and similarly for other languages.
+,
+ and similarly for other languages.
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-If the package should only available for you or you don't have admin permissions
-, do the same, but in the local \SpecialChar LaTeX
+If the package should only available for you or you don't have admin permissions,
+ do the same,
+ but in the local \SpecialChar LaTeX
folder.
E.
\begin_inset space \thinspace{}
\end_inset
-g., for MiK\SpecialChar TeX
+g.,
+ for MiK\SpecialChar TeX
\begin_inset space ~
\end_inset
-2.8 under Windows XP, this would be the folder:
+2.8 under Windows XP,
+ this would be the folder:
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
-On Vista, it would be:
+On Vista,
+ it would be:
\begin_inset Newline newline
\end_inset
\end_inset
from a console.
- If you installed the package for all users, then you will probably need
- to have root permissions for that.
+ If you installed the package for all users,
+ then you will probably need to have root permissions for that.
\end_layout
\begin_layout Enumerate
For MiK\SpecialChar TeX
-, if you have installed the package for all users, start the program
-
+,
+ if you have installed the package for all users,
+ start the program
\begin_inset Quotes eld
\end_inset
\end_deeper
\begin_layout Enumerate
-Finally, you need to tell \SpecialChar LyX
+Finally,
+ you need to tell \SpecialChar LyX
that there are new packages available.
- So, in \SpecialChar LyX
-, use the menu
+ So,
+ in \SpecialChar LyX
+,
+ use the menu
\begin_inset Flex Noun
status collapsed
\begin_layout Standard
Now the package is installed.
- In our example, the document class
+ In our example,
+ the document class
\begin_inset Flex Code
status collapsed
\begin_layout Standard
If you would like to use a \SpecialChar LaTeX
- document class that is not even listed in the
- menu
+ document class that is not even listed in the menu
\begin_inset Flex Noun
status collapsed
\end_inset
-, then you need to create a `layout' file for it.
+,
+ then you need to create a `layout' file for it.
That is the topic of the next section.
\end_layout
\begin_layout Standard
This section describes the various sorts of \SpecialChar LyX
- files that contain layout informati
-on.
- These files describe various paragraph and character styles, determining
- how \SpecialChar LyX
+ files that contain layout information.
+ These files describe various paragraph and character styles,
+ determining how \SpecialChar LyX
should display them and how they should be translated into \SpecialChar LaTeX
-, DocBook,
- XHTML, or whatever output format is being used.
+,
+ DocBook,
+ XHTML,
+ or whatever output format is being used.
\end_layout
\begin_layout Standard
-We shall try to provide a thorough description of the process of writing
- layout files here.
- However, there are so many different types of documents supported even
- by just \SpecialChar LaTeX
- that we can't hope to cover every different possibility or problem
- you might encounter.
+We shall try to provide a thorough description of the process of writing layout files here.
+ However,
+ there are so many different types of documents supported even by just \SpecialChar LaTeX
+ that we can't hope to cover every different possibility or problem you might encounter.
The \SpecialChar LyX
- users' list is frequented by people with lots of experience with layout
- design who are willing to share what they've learned, so please feel free
- to ask questions there.
+ users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
+ so please feel free to ask questions there.
\end_layout
\begin_layout Standard
-As you prepare to write a new layout, it is extremely helpful to look at
- the layouts distributed with \SpecialChar LyX
+As you prepare to write a new layout,
+ it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
.
If you write a \SpecialChar LyX
layout for a \SpecialChar LaTeX
- document class that might also be used by
- others, or write a module that might be useful to others, then you should
- consider posting your layout to the
+ document class that might also be used by others,
+ or write a module that might be useful to others,
+ then you should consider posting your layout to the
\begin_inset CommandInset href
LatexCommand href
name "layout section on the LyX wiki"
\end_inset
or even to the \SpecialChar LyX
- developers' list, so that it might be included in \SpecialChar LyX
+ developers' list,
+ so that it might be included in \SpecialChar LyX
itself.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Note that \SpecialChar LyX
- is licensed under the General Public License, so any material
- that is contributed to \SpecialChar LyX
+ is licensed under the General Public License,
+ so any material that is contributed to \SpecialChar LyX
must be similarly licensed.
\end_layout
\begin_layout Standard
We have spoken to this point about `layout files'.
But there are different sorts of files that contain layout information.
- Layout files, strictly so called, have the
+ Layout files,
+ strictly so called,
+ have the
\begin_inset Flex Code
status collapsed
\emph on
modules
\emph default
-, which have the
+,
+ which have the
\begin_inset Flex Code
status collapsed
extension.
Modules are to \SpecialChar LaTeX
packages much as layouts are to \SpecialChar LaTeX
- classes, and some modules—such
- as the
+ classes,
+ and some modules—
+such as the
\begin_inset Flex Code
status collapsed
\end_inset
- module—specifically provide support for one package.
- In a sense, layout modules are similar to included
+ module—
+specifically provide support for one package.
+ In a sense,
+ layout modules are similar to included
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-These can have any extension, but by convention have the
+These can have any extension,
+ but by convention have the
\begin_inset Flex Code
status collapsed
\end_inset
- files—files like
+ files—
+files like
\begin_inset Flex Code
status collapsed
\end_inset
-—in that modules are not specific to a given document class but may be used
- with many different classes.
+—
+in that modules are not specific to a given document class but may be used with many different classes.
The difference is that using an included file with
\begin_inset Flex Code
status collapsed
\end_inset
requires editing that file.
- Modules, by contrast, are selected in the
+ Modules,
+ by contrast,
+ are selected in the
\begin_inset Flex Noun
status collapsed
\begin_layout Standard
Building modules is the easiest way to get started with layout editing,
- since it can be as simple as adding a single new paragraph style or flex
- inset.
- But modules may, in principle, contain anything a layout file can contain.
+ since it can be as simple as adding a single new paragraph style or flex inset.
+ But modules may,
+ in principle,
+ contain anything a layout file can contain.
\end_layout
\begin_layout Standard
\end_inset
- folder, you will need to reconfigure and then restart \SpecialChar LyX
- for the module to
- appear in the menu.
- However, changes you make to the module will be seen immediately, if you
- open
+ folder,
+ you will need to reconfigure and then restart \SpecialChar LyX
+ for the module to appear in the menu.
+ However,
+ changes you make to the module will be seen immediately,
+ if you open
\begin_inset Flex Noun
status collapsed
\end_inset
-, highlight something, and then hit
+,
+ highlight something,
+ and then hit
\begin_inset Quotes eld
\end_inset
It is strongly recommended that you save your work before doing this
\emph default
.
- In fact,
+ In fact,
+
\emph on
-it is strongly recommended that you not attempt to edit modules while simultaneo
-usly working on actual documents
+it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
\emph default
.
Though of course the developers strive to keep \SpecialChar LyX
Modules are to \SpecialChar LyX
as packages are to \SpecialChar LaTeX
.
- Sometimes, however, you find yourself wanting a specific inset or character
- style just for one document and writing a module that will also be available
- to other documents makes little sense.
+ Sometimes,
+ however,
+ you find yourself wanting a specific inset or character style just for one document and writing a module that will also be available to other documents makes little sense.
What you need is \SpecialChar LyX
's
\begin_inset Quotes eld
Local Layout
\family default
.
- The large text box allows you to enter anything that you might enter in
- a layout file or module.
- You can think of a document's local layout, in fact, as a module that belongs
- just to it.
- So, in particular, you must enter a
+ The large text box allows you to enter anything that you might enter in a layout file or module.
+ You can think of a document's local layout,
+ in fact,
+ as a module that belongs just to it.
+ So,
+ in particular,
+ you must enter a
\begin_inset Flex Code
status collapsed
\end_inset
tag.
- Any format is acceptable, but one would normally use the format current
- at the time.
+ Any format is acceptable,
+ but one would normally use the format current at the time.
(In \SpecialChar LyX
\begin_inset Info
arg "version"
\end_inset
-, the current layout format is
+,
+ the current layout format is
\begin_inset Info
type "lyxinfo"
arg "layoutformat"
\end_inset
- pane, \SpecialChar LyX
+ pane,
+ \SpecialChar LyX
will enable the
\begin_inset Quotes eld
\end_inset
button at the bottom.
Clicking this button will cause \SpecialChar LyX
- to determine whether what you have entered
- is valid layout information for the chosen format.
+ to determine whether what you have entered is valid layout information for the chosen format.
\SpecialChar LyX
- will report the result but, unfortunately, will not tell you what errors
- there might have been.
- These will be written to the terminal, however, if \SpecialChar LyX
+ will report the result but,
+ unfortunately,
+ will not tell you what errors there might have been.
+ These will be written to the terminal,
+ however,
+ if \SpecialChar LyX
is started from a terminal.
- You will not be permitted to save your local layout until you have entered
- something valid.
+ You will not be permitted to save your local layout until you have entered something valid.
\end_layout
\begin_layout Standard
-The warnings at the end of the previous section apply here, too.
- Do not play with local layout while you are actually working, especially
- if you have not saved your document.
- That said, using local layout with a test document can be a very convenient
- way to try out layout ideas, or even to start developing a module.
+The warnings at the end of the previous section apply here,
+ too.
+ Do not play with local layout while you are actually working,
+ especially if you have not saved your document.
+ That said,
+ using local layout with a test document can be a very convenient way to try out layout ideas,
+ or even to start developing a module.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-There are two situations you are likely to encounter when wanting to support
- a new \SpecialChar LaTeX
- document class, involving style (
+There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
+ document class,
+ involving style (
\begin_inset Flex Code
status collapsed
Supporting a new class file is a bit harder.
We'll discuss the former in this section and the latter in the next.
-\change_deleted 5863208 1594239023
-Similar remarks apply, of course, if you want to support a new DocBook DTD.
-\change_unchanged
-
\end_layout
\begin_layout Standard
-The easier case is the one in which your new document class is provided
- as a style file that is to be used in conjunction with an already supported
- document class.
- For the sake of the example, we'll assume that the style file is called
-
+The easier case is the one in which your new document class is provided as a style file that is to be used in conjunction with an already supported document class.
+ For the sake of the example,
+ we'll assume that the style file is called
\begin_inset Flex Noun
status collapsed
\end_inset
-, which is a standard class.
+,
+ which is a standard class.
\end_layout
status collapsed
\begin_layout Plain Layout
-Of course, which directory is your local directory will vary by platform,
+Of course,
+ which directory is your local directory will vary by platform,
and \SpecialChar LyX
- allows you to specify your local directory on startup, too, using
- the
+ allows you to specify your local directory on startup,
+ too,
+ using the
\begin_inset Flex Code
status collapsed
\end_inset
- and change the line:
+ and change the line:
+
\end_layout
\begin_layout LyX-Code
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
+DeclareLaTeXClass[report,
+ myclass.sty]{Report (My Class)}
\end_layout
\begin_layout Standard
\end_inset
dialog.
- It is likely that some of the sectioning commands and such in your new
- class will work differently from how they worked in the base class—
+ 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—
+
\begin_inset Flex Code
status collapsed
\end_inset
- in this example—so you can fiddle around with the settings for the different
- sections if you wish.
+ in this example—
+so you can fiddle around with the settings for the different sections if you wish.
The layout information for sections is contained in
\begin_inset Flex Code
status collapsed
\end_inset
-, but you do not need to copy and change this file.
- Instead, you can simply add your changes to your layout file, after the
- line
+,
+ but you do not need to copy and change this file.
+ Instead,
+ you can simply add your changes to your layout file,
+ after the line
\begin_inset Flex Code
status collapsed
\end_inset
-, which itself includes
+,
+ which itself includes
\begin_inset Flex Code
status collapsed
\end_inset
.
- For example, you might add these lines:
+ For example,
+ you might add these lines:
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
to change the font for chapter headings to sans-serif.
- This will override (or, in this case, add to) the existing declaration
- for the Chapter style.
+ This will override (or,
+ in this case,
+ add to) the existing declaration for the Chapter style.
\end_layout
\begin_layout Standard
-Your new package may also provide commands or environments not present in
- the base class.
- In this case, you will want to add these to the layout file.
+Your new package may also provide commands or environments not present in the base class.
+ In this case,
+ you will want to add these to the layout file.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:TextClass"
+nolink "false"
\end_inset
\end_inset
- can be used with several different document classes, and even if it cannot,
- you might find it easiest just to write a module that you can load with
- the base class.
+ can be used with several different document classes,
+ and even if it cannot,
+ you might find it easiest just to write a module that you can load with the base class.
The simplest possible such module would be:
\end_layout
\end_layout
\begin_layout Standard
-A more complex module might modify the behavior of some existing constructs
- or define some new ones.
- Again, see
+A more complex module might modify the behavior of some existing constructs or define some new ones.
+ Again,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:TextClass"
+nolink "false"
\end_inset
\begin_layout Standard
There are two possibilities here.
One is that the class file is itself based upon an existing document class.
- For example, many thesis classes are based upon
+ For example,
+ many thesis classes are based upon
\begin_inset Flex Noun
status collapsed
\end_inset
.
- To see whether yours is, look for a line like
+ To see whether yours is,
+ look for a line like
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
in the file.
- If so, then you may proceed largely as in the previous section, though
- the
+ If so,
+ then you may proceed largely as in the previous section,
+ though the
\begin_inset Flex Code
status collapsed
\end_inset
-, then the line should read:
+,
+ then the line should read:
\begin_inset Foot
status collapsed
\end_inset
-: \SpecialChar LyX
+:
+ \SpecialChar LyX
assumes that the document class has the same name as the layout file.
\end_layout
\end_layout
\begin_layout Standard
-If, on the other hand, the new class is not based upon an existing class,
+If,
+ on the other hand,
+ the new class is not based upon an existing class,
you will probably have to
\begin_inset Quotes eld
\end_inset
\end_inset
layout.
- We strongly suggest copying an existing layout file which uses a similar
- \SpecialChar LaTeX
- class and then modifying it, if you can do so.
- At least use an existing file as a starting point so you can find out what
- items you need to worry about.
- Again, the specifics are covered below.
+ We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
+ class and then modifying it,
+ if you can do so.
+ At least use an existing file as a starting point so you can find out what items you need to worry about.
+ Again,
+ the specifics are covered below.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-Once you have written a layout file for a new document class, you might
- want to consider writing a
+Once you have written a layout file for a new document class,
+ you might want to consider writing a
\emph on
template
\emph default
- for it, too.
- A template acts as a kind of tutorial for your layout, showing how it might
- be used, though containing dummy content.
+ for it,
+ too.
+ A template acts as a kind of tutorial for your layout,
+ showing how it might be used,
+ though containing dummy content.
You can of course look at the various templates included with \SpecialChar LyX
for ideas.
\end_layout
\begin_layout Standard
-Templates are created just like usual documents: using \SpecialChar LyX
+Templates are created just like usual documents:
+ using \SpecialChar LyX
.
The only difference is that usual documents contain all possible settings,
including the font scheme and the paper size.
- Usually a user doesn't want a template to overwrite his preferred settings
- for such parameters.
- For that reason, the designer of a template should remove the corresponding
- commands like
+ Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
+ For that reason,
+ the designer of a template should remove the corresponding commands like
\begin_inset Flex Code
status collapsed
from the template \SpecialChar LyX
file.
- This can be done with any simple text-editor, for example
+ This can be done with any simple text-editor,
+ for example
\begin_inset Flex Code
status collapsed
\end_inset
-, copy the ones you use from the global template directory in
+,
+ copy the ones you use from the global template directory in
\begin_inset Flex Code
status collapsed
\end_inset
- to the same place, and redefine the template path in the
+ to the same place,
+ and redefine the template path in the
\begin_inset Flex Noun
status collapsed
\end_layout
\begin_layout Standard
-Note, by the way, that there is a template which has a particular meaning:
+Note,
+ by the way,
+ that there is a template which has a particular meaning:
\begin_inset Newline linebreak
\end_inset
in order to provide useful defaults.
To create this template from inside \SpecialChar LyX
-, all you have to do is to open a document
- with the correct settings, and use the
+,
+ all you have to do is to open a document with the correct settings,
+ and use the
\begin_inset Flex Noun
status collapsed
\begin_layout Standard
The format of layout files changes with each \SpecialChar LyX
- release, so old layout files
- need to be converted to the new format.
+ release,
+ so old layout files need to be converted to the new format.
If \SpecialChar LyX
- reads a layout file in an older format, it automatically calls the
- script
+ reads a layout file in an older format,
+ it automatically calls the script
\begin_inset Flex Code
status collapsed
to convert it to a temporary file in current format.
The original file is left untouched.
- If you use the layout file often, then, you may want to convert it permanently,
+ If you use the layout file often,
+ then,
+ you may want to convert it permanently,
so that \SpecialChar LyX
does not have to do so itself every time.
- To do this, you can call the converter manually:
+ To do this,
+ you can call the converter manually:
\end_layout
\begin_layout Enumerate
\end_layout
\begin_layout Standard
-Note that manual conversion does not affect included files, so these will
- have to be converted separately.
+Note that manual conversion does not affect included files,
+ so these will have to be converted separately.
\end_layout
\begin_layout Subsection
sub-directory.
Their purpose is to define the specifics of \SpecialChar LaTeX
- packages aimed at bibliography
- generation, such as
+ packages aimed at bibliography generation,
+ such as
\family sans
natbib
\family default
,
+
\family sans
jurabib
\family default
\family sans
biblatex
\family default
-, but also the way how normal Bib\SpecialChar TeX
- citations (without additional packages)
- are handled in \SpecialChar LyX
+,
+ but also the way how normal Bib\SpecialChar TeX
+ citations (without additional packages) are handled in \SpecialChar LyX
is defined in such a file.
\end_layout
\begin_layout Standard
-More specifically, it is defined which packages \SpecialChar LyX
- needs to load, which citation
- commands are available, how these are to be displayed in \SpecialChar LyX
+More specifically,
+ it is defined which packages \SpecialChar LyX
+ needs to load,
+ which citation commands are available,
+ how these are to be displayed in \SpecialChar LyX
(in the workarea,
- the dialogs, the context menus) as well as in the XHTML and plain text
- output.
- Furthermore, the files specify available style variants (author-year, numerical
-, etc.) and their specifics.
- The cite engine files are also used to generate the options that are available
- in
+ the dialogs,
+ the context menus) as well as in the XHTML and plain text output.
+ Furthermore,
+ the files specify available style variants (author-year,
+ numerical,
+ etc.) and their specifics.
+ The cite engine files are also used to generate the options that are available in
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
\end_layout
\begin_layout Standard
-Even though a cite engine file is essentially a normal layout file that
- could theoretically include any layout information, it usually primarily
- includes some specific parameters such as
+Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
+ it usually primarily includes some specific parameters such as
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Citation-format-description"
+nolink "false"
\end_inset
-, as well as in the files themselves.
+,
+ as well as in the files themselves.
\end_layout
\begin_layout Section
\begin_layout Standard
The following sections describe how layout files are structured and written.
- Our advice is to go slowly, save and test often.
- It is really not that hard, except that the multitude of options can become
- overwhelming, especially if you try to check out too many at once.
+ Our advice is to go slowly,
+ save and test often.
+ It is really not that hard,
+ except that the multitude of options can become overwhelming,
+ especially if you try to check out too many at once.
It becomes easier if you use existing layouts of \SpecialChar LyX
- as examples/reference
- or if you modify an existing layout to your needs.
+ as examples/reference or if you modify an existing layout to your needs.
\end_layout
\begin_layout Standard
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-, the default is shown like this:
+,
+ the default is shown like this:
+
\begin_inset Flex Code
status collapsed
\begin_layout LyX-Code
\size small
-#% Do not delete the line below; configure depends on this
+#% Do not delete the line below;
+ configure depends on this
\end_layout
\begin_layout LyX-Code
\end_inset
-, in a special mode where
+,
+ in a special mode where
\begin_inset Flex Code
status collapsed
is ignored.
The first line is just a \SpecialChar LaTeX
- comment, the second one contains the mandatory
- declaration of the text class and the third line contains the optional
- classification of the class.
+ comment,
+ the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
If these lines appear in a file named
\begin_inset Flex Code
status collapsed
\end_inset
-, then they define a text class of name
+,
+ then they define a text class of name
\begin_inset Flex Code
status collapsed
\end_inset
- dialog: the text classes are grouped by these categories (which are usually
- genres, so typical categories are
+ dialog:
+ the text classes are grouped by these categories (which are usually genres,
+ so typical categories are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Quotes eld
\end_inset
\end_inset
etc.).
- If no category has been declared, the class will be put in the
+ If no category has been declared,
+ the class will be put in the
\begin_inset Quotes eld
\end_inset
\end_inset
- document class, but where you changed the appearance of the section headings.
+ document class,
+ but where you changed the appearance of the section headings.
If you put it in a file
\begin_inset Flex Code
status collapsed
\end_inset
-, the header of this file should be:
+,
+ the header of this file should be:
\end_layout
\begin_layout LyX-Code
\size small
-#% Do not delete the line below; configure depends on this
+#% Do not delete the line below;
+ configure depends on this
\end_layout
\begin_layout LyX-Code
\end_inset
-, associated with the \SpecialChar LaTeX
+,
+ associated with the \SpecialChar LaTeX
document class
\begin_inset Flex Code
status collapsed
\end_inset
.
- If your text class depends on several packages, you can declare it as:
+ If your text class depends on several packages,
+ you can declare it as:
\end_layout
\begin_layout LyX-Code
\size small
-#% Do not delete the line below; configure depends on this
+#% Do not delete the line below;
+ configure depends on this
\end_layout
\begin_layout LyX-Code
package.
-\change_deleted 5863208 1594239179
-Finally, it is also possible to declare classes for DocBook code.
- Typical declarations will look like:
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted 5863208 1594239179
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted 5863208 1594239179
-
-\size small
-#
-\backslash
-DeclareDocBookClass[article]{SGML (DocBook Article)}
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted 5863208 1594239179
-
-\size small
-#
-\backslash
-DeclareCategory{Articles (DocBook)}
-\change_unchanged
-
\end_layout
\begin_layout Standard
-Note that these declarations can also be given an optional parameter declaring
- the name of the document class (but not a list).
+Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
\end_layout
\begin_layout Standard
-So, to be as explicit as possible, the form of the layout declaration is:
+So,
+ to be as explicit as possible,
+ the form of the layout declaration is:
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
The class need only be specified if the name of the \SpecialChar LaTeX
- class file and the
- name of the layout file are different or if there are packages to load.
- If the name of the class file is not specified, then \SpecialChar LyX
- will simply assume
- that it is the same as the name of the layout file.
+ class file and the name of the layout file are different or if there are packages to load.
+ If the name of the class file is not specified,
+ then \SpecialChar LyX
+ will simply assume that it is the same as the name of the layout file.
\end_layout
\begin_layout Standard
-When the text class has been modified to your taste, all you have to do
- is to copy it either to
+When the text class has been modified to your taste,
+ all you have to do is to copy it either to
\begin_inset Flex Code
status collapsed
\end_inset
-, run
+,
+ run
\begin_inset Flex Noun
status collapsed
\end_inset
-, exit \SpecialChar LyX
+,
+ exit \SpecialChar LyX
and restart.
Then your new text class should be available along with the others.
\end_layout
\begin_layout Standard
-Once the layout file is installed, you can edit it and see your changes
- without having to reconfigure or to restart \SpecialChar LyX
+Once the layout file is installed,
+ you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
In versions of \SpecialChar LyX
- prior to 1.6, this was not true.
- As a result, editing layout files was very time consuming, since you had
- constantly to restart \SpecialChar LyX
+ prior to 1.6,
+ this was not true.
+ As a result,
+ editing layout files was very time consuming,
+ since you had constantly to restart \SpecialChar LyX
to see changes.
\end_layout
\end_inset
.
- There is no default binding for this function—though, of course, you can
- bind it to a key yourself.
- But you will normally use this function simply by entering it in the mini-buffe
-r.
+ There is no default binding for this function—
+though,
+ of course,
+ you can bind it to a key yourself.
+ But you will normally use this function simply by entering it in the mini-buffer.
\end_layout
\emph on
Warning
\emph default
-:
+:
+
\begin_inset Flex Noun
status collapsed
strongly
\emph default
recommended that you save your work before using this function.
- In fact, it is
+ In fact,
+ it is
\emph on
strongly
\emph default
- recommended that you not attempt to edit layout information while simultaneousl
-y working on a document that you care about.
+ recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
Use a test document.
Syntax errors and the like in your layout file could cause peculiar behavior.
- In particular, such errors could cause \SpecialChar LyX
- to regard the current layout as
- invalid and to attempt to switch to some other layout.
+ In particular,
+ such errors could cause \SpecialChar LyX
+ to regard the current layout as invalid and to attempt to switch to some other layout.
\begin_inset Foot
status collapsed
The \SpecialChar LyX
team strives to keep \SpecialChar LyX
- stable in such situations, but safe is better
- than sorry.
+ stable in such situations,
+ but safe is better than sorry.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-While we're giving advice: make regular backups.
+While we're giving advice:
+ make regular backups.
And be nice to your mother.
\end_layout
#
\backslash
DeclareLyXModule[endnotes.sty]{Endnotes}
-\change_inserted -712698321 1554395911
-
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1554395924
-
\size small
#
\backslash
DeclareCategory{Foot- and Endnotes}
-\change_deleted -712698321 1554395911
-
-\size default
-
-\change_unchanged
-
\end_layout
\begin_layout Standard
-The mandatory argument
-\change_inserted -712698321 1554395956
- of
+The mandatory argument of
\family typewriter
\backslash
DeclareLyXModule
-\change_unchanged
-
\family default
-, in curly brackets, is the name of the module, as it should appear in
+,
+ in curly brackets,
+ is the name of the module,
+ as it should appear in
\begin_inset Flex Noun
status collapsed
\end_inset
.
- The argument in square brackets is optional: It declares any \SpecialChar LaTeX
- packages
- on which the module depends.
+ The argument in square brackets is optional:
+ It declares any \SpecialChar LaTeX
+ packages on which the module depends.
It is also possible to use the form
\begin_inset Flex Noun
status collapsed
\end_inset
- as an optional argument, which declares that the module can only be used
- when there exists a conversion chain between the formats `
+ as an optional argument,
+ which declares that the module can only be used when there exists a conversion chain between the formats `
\begin_inset Flex Code
status collapsed
\end_inset
'.
-
-\change_inserted -712698321 1554396133
The
\family typewriter
\backslash
DeclareCategory
\family default
- declaration is not strictly mandatory, but you should add it, since it
- is helpful to find the module.
+ declaration is not strictly mandatory,
+ but you should add it,
+ since it is helpful to find the module.
Please have a look at the existing module categories and if appropriate,
use one of those.
-\change_unchanged
-
\end_layout
\begin_layout Standard
-The module
-\change_inserted -712698321 1554395988
-and category
-\change_unchanged
-declaration should then be followed by lines like the following:
+The module and category declaration should then be followed by lines like the following:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Preferably in English if the module should be published with \SpecialChar LyX
.
- This description will appear in the list of messages to be translated and
- will be thus translated with the next interface update.
+ This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
\end_layout
\end_inset
\end_layout
\begin_layout LyX-Code
-#Adds an endnote command, in addition to footnotes.
+#Adds an endnote command,
+ in addition to footnotes.
\end_layout
\end_layout
\begin_layout LyX-Code
-#Requires: somemodule | othermodule
+#Requires:
+ somemodule | othermodule
\end_layout
\begin_layout LyX-Code
-#Excludes: badmodule
+#Excludes:
+ badmodule
\end_layout
\begin_layout Standard
\end_inset
line is used to identify modules with which this one may not be used.
- Both are optional, and, as shown, multiple modules should be separated
- with the pipe symbol: |.
- Note that the required modules are treated disjunctively:
+ Both are optional,
+ and,
+ as shown,
+ multiple modules should be separated with the pipe symbol:
+ |.
+ Note that the required modules are treated disjunctively:
+
\emph on
at least one
\emph default
of the required modules must be used.
- Similarly,
+ Similarly,
+
\emph on
no
\emph default
\end_layout
\begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the cite style,
+The mandatory argument,
+ in curly brackets,
+ is the name of the cite style,
as it should appear in
\begin_inset Flex Noun
status collapsed
\end_inset
.
- The argument in square brackets is optional: It declares any \SpecialChar LaTeX
- packages
- on which the cite engine depends.
+ The argument in square brackets is optional:
+ It declares any \SpecialChar LaTeX
+ packages on which the cite engine depends.
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
Preferably in English if the module should be published with \SpecialChar LyX
.
- This description will appear in the list of messages to be translated and
- will be thus translated with the next interface update.
+ This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
\end_layout
\end_inset
\end_layout
\begin_layout LyX-Code
-# customizable, fully localized and provides many features
+# customizable,
+ fully localized and provides many features
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-The first non-comment line of any layout file, included file, or module
-
+The first non-comment line of any layout file,
+ included file,
+ or module
\emph on
must
\emph default
1.4.0.
Layout files from older \SpecialChar LyX
- versions do not have an explicit file format and
- are considered to have
+ versions do not have an explicit file format and are considered to have
\begin_inset Flex Code
status collapsed
is format 60.
But each version of \SpecialChar LyX
is capable of reading earlier versions' layout files,
- just as they are capable of reading files produced by earlier versions
- of \SpecialChar LyX
+ just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
.
- There is, however, no provision for converting to earlier formats.
+ There is,
+ however,
+ no provision for converting to earlier formats.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-These are general parameters that govern the behavior of an entire document
- class.
+These are general parameters that govern the behavior of an entire document class.
(This does
\emph on
not
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1526899478
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1526898610
AddToCiteEngine <engine>
-\change_unchanged
-
\end_layout
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1526898823
End
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
block when the document is output to XHTML.
- Typically, this would be used to output CSS style information, but it can
- be used for anything that can appear in
+ Typically,
+ this would be used to output CSS style information,
+ but it can be used for anything that can appear in
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1562592950
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1562593040
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1562592954
BibInToc
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1562592950
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1562592950
1
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1562592996
1
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1562593006
true
-\change_unchanged
-
\end_layout
\end_inset
).
This prevents the bibliography from being added twice.
-\change_unchanged
-
\end_layout
\begin_layout Description
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
).
-
-\change_inserted -712698321 1526898530
- Note that if you specify this in a layout file or module, any cite engine
- definition will be overridden.
+ Note that if you specify this in a layout file or module,
+ any cite engine definition will be overridden.
Also see
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1526898530
AddToCiteEngine
-\change_unchanged
-
\end_layout
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Citation-format-description"
+nolink "false"
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
).
-
-\change_inserted -712698321 1526898585
- A cite format defined in a layout or module will override the cite engine
- definition.
-\change_unchanged
-
+ A cite format defined in a layout or module will override the cite engine definition.
\end_layout
\begin_layout Description
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:ClassOptions"
+nolink "false"
\end_inset
\end_inset
] This sequence defines the properties for a counter.
- If the counter does not yet exist, it is created; if it does exist, it
- is modified.
+ If the counter does not yet exist,
+ it is created;
+ if it does exist,
+ it is modified.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Counters"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_inset
extension.
- The user can still remove the module, but it will be active at the outset.
- (This applies only when new files are created, or when this class is chosen
- for an existing document.)
+ The user can still remove the module,
+ but it will be active at the outset.
+ (This applies only when new files are created,
+ or when this class is chosen for an existing document.)
\end_layout
\begin_layout Description
\end_inset
-] This is the style that will be assigned to new paragraphs, usually
+] This is the style that will be assigned to new paragraphs,
+ usually
\begin_inset Flex Noun
status collapsed
\end_inset
.
- This will default to the first defined style if not given, but you are
- encouraged to use this directive.
+ This will default to the first defined style if not given,
+ but you are encouraged to use this directive.
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515112870
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515112782
DocBookRoot
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515112766
string
-\change_unchanged
-
\end_layout
\end_inset
-] The root element (at the top of the document) to use when outputting documents
- with this class in DocBook.
+] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
The default value is
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515112845
article
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
.
-
-\change_deleted 1075283030 1594226862
-
-\change_inserted 1075283030 1594226777
-
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1594226859
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1594226785
DocBookForceAbstract
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1594226804
boolean
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, the root element will always have an
+,
+ the root element will always have an
\family typewriter
<abstract>
\family default
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
-] This tag indicates that the module (which is specified by filename without
- the
+] This tag indicates that the module (which is specified by filename without the
\begin_inset Flex Code
status collapsed
\end_inset
extension) cannot be used with this document class.
- This might be used in a journal-specific layout file to prevent, say, the
- use of the
+ This might be used in a journal-specific layout file to prevent,
+ say,
+ the use of the
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Layout-modules"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Floats"
+nolink "false"
\end_inset
\end_inset
-] The style to use for the table of contents, bibliography, and so forth,
+] The style to use for the table of contents,
+ bibliography,
+ and so forth,
when the document is output to HTML.
- For articles, this should normally be
+ For articles,
+ this should normally be
\begin_inset Flex Code
status collapsed
\end_inset
-; for books
+;
+ for books
\begin_inset Flex Code
status collapsed
\end_inset
.
- If it is not given, then \SpecialChar LyX
+ If it is not given,
+ then \SpecialChar LyX
will attempt to figure out which layout to use.
\end_layout
\end_inset
] Modifies the properties of the given counter.
- If the counter does not exist, the statement is ignored.
+ If the counter does not exist,
+ the statement is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Counters"
+nolink "false"
\end_inset
\end_inset
-] This allows you to include another layout definition file within yours
- to avoid duplicating commands.
- Common examples are the standard layout files, for example,
+] This allows you to include another layout definition file within yours to avoid duplicating commands.
+ Common examples are the standard layout files,
+ for example,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, which contains most of the basic layouts.
-\change_inserted -712698321 1611646803
-
+,
+ which contains most of the basic layouts.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1611646804
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646837
InputGlobal
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646804
<filename>
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646804
Input
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646804
name.layout
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646804
name.inc
-\change_unchanged
-
\end_layout
\end_inset
- in the user directory which includes a global file with the same name via
-
+ in the user directory which includes a global file with the same name via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646853
InputGlobal name
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646855
InputGlobal name.inc
-\change_unchanged
-
\end_layout
\end_inset
-, respectively (with
+,
+ respectively (with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1611646804
Input
-\change_unchanged
-
\end_layout
\end_inset
-, the file would recursively include itself).
- This way, you can modify global files without having to completely copy
- them.
-\change_unchanged
-
+,
+ the file would recursively include itself).
+ This way,
+ you can modify global files without having to completely copy them.
\end_layout
\begin_layout Description
\end_inset
] This section (re-)defines the layout of an inset.
- It can be applied to an existing inset or to a new, user-defined inset,
- e.g., a new character style.
+ It can be applied to an existing inset or to a new,
+ user-defined inset,
+ e.g.,
+ a new character style.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Flex-insets-and"
+nolink "false"
\end_inset
\end_inset
-] A string that indicates the width of the left margin on the screen, for
- example,
+] A string that indicates the width of the left margin on the screen,
+ for example,
+
\begin_inset Quotes eld
\end_inset
\end_inset
.
- (Note that this is not a `length', like
+ (Note that this is not a `length',
+ like
\begin_inset Quotes eld
\end_inset
\end_inset
-] An integer that determines the maximal number of names displayed in an
- author-year citation before the citation switches to
+] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
\begin_inset Quotes eld
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1612018485
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018457
ModifyInsetLayout
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018466
<type>
-\change_unchanged
-
\end_layout
\end_inset
] Modifies the layout of an inset.
- If the layout does not exist, this section is ignored.
+ If the layout does not exist,
+ this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018452
End
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
] Modifies the properties of the given paragraph style.
- If the style does not exist, this section is ignored.
+ If the style does not exist,
+ this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
-] Deletes an existing counter, usually one defined in an included file.
+] Deletes an existing counter,
+ usually one defined in an included file.
\end_layout
\begin_layout Description
\end_inset
] Deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- been defined in an input file.
+ This is particularly useful when you want to suppress a float that has been defined in an input file.
\end_layout
\begin_layout Description
\end_inset
] The file format (as defined in the \SpecialChar LyX
- preferences) produced by this document
- class.
+ preferences) produced by this document class.
It is mainly useful when
\begin_inset Flex Code
status collapsed
and one wants to define a new type of literate document.
The format is reset to
-\change_deleted 5863208 1594239413
-
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-docbook
+latex
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- or
-\change_unchanged
-
-\begin_inset Quotes eld
-\end_inset
-
-
+ when the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex
+OutputType
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- when the corresponding
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-OutputType
-\end_layout
-
-\end_inset
-
- parameter is encountered.
-\end_layout
+ parameter is encountered.
+\end_layout
\begin_layout Description
\begin_inset Flex Code
\end_inset
-,
-\change_deleted 5863208 1594239430
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-docbook
-\end_layout
-
-\end_inset
-
,
-\change_unchanged
\begin_inset Flex Code
status collapsed
\end_inset
-] Specifies options, given in the second string, for the package named by
- the first string.
- For example,
+] Specifies options,
+ given in the second string,
+ for the package named by the first string.
+ For example,
+
\begin_inset Quotes eld
\end_inset
option.
(For \SpecialChar TeX
-perts, this causes \SpecialChar LyX
- to output:
+perts,
+ this causes \SpecialChar LyX
+ to output:
+
\begin_inset Flex Code
status collapsed
\end_inset
.)
-\change_inserted -712698321 1565102364
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1565102470
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565102365
PageSize
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1565105222
-
\emph on
custom
\emph default
-, letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
- b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
-\change_unchanged
-
+,
+ letter,
+ legal,
+ executive,
+ a0,
+ a1,
+ a2,
+ a3,
+ a4,
+ a5,
+ a6,
+ b0,
+ b1,
+ b2,
+ b3,
+ b4,
+ b5,
+ b6,
+ c0,
+ c1,
+ c2,
+ c3,
+ c4,
+ c5,
+ c6,
+ b0j,
+ b1j,
+ b2j,
+ b3j,
+ b4j,
+ b5j,
+ b6j
\end_layout
\end_inset
] The default page size.
This is used by some converters.
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1612018500
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1612018547
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018506
ProvideInsetLayout
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018509
<type>
-\change_unchanged
-
\end_layout
\end_inset
] Defines the layout of an inset if it does not already exist.
- If the layout does exist, this section is ignored.
+ If the layout does exist,
+ this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1612018500
End
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:List-of-functions"
+nolink "false"
\end_inset
\end_inset
tag to indicate that it ought to be used.
- It could also be used in a module that provided an alternate implementation
- of the same functionality.
+ It could also be used in a module that provided an alternate implementation of the same functionality.
\end_layout
\begin_layout Description
\end_inset
] Creates a new paragraph style if it does not already exist.
- If the style does exist, this section is ignored.
+ If the style does exist,
+ this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:List-of-functions"
+nolink "false"
\end_inset
for the list of features.).
- If you require a package with specific options, you can additionally use
-
+ If you require a package with specific options,
+ you can additionally use
\begin_inset Flex Code
status collapsed
\end_inset
-] A string that indicates the width of the right margin on the screen, for
- example,
+] A string that indicates the width of the right margin on the screen,
+ for example,
+
\begin_inset Quotes eld
\end_inset
\end_inset
-] Whether the class-default should be printing on one or both sides of the
- paper.
+] Whether the class-default should be printing on one or both sides of the paper.
Can be changed in the
\begin_inset Flex Noun
status collapsed
\end_inset
] This sequence defines a paragraph style.
- If the style does not yet exist, it is created; if it does exist, its parameter
-s are modified.
+ If the style does not yet exist,
+ it is created;
+ if it does exist,
+ its parameters are modified.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
for details on paragraph styles.
-\change_inserted -712698321 1553617804
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1553617862
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553617809
TableStyle
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553617805
<name>
-\change_unchanged
-
\end_layout
\end_inset
\begin_deeper
\begin_layout Itemize
-
-\change_inserted -712698321 1554308039
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1554307928
Formal_with_Footline
-\change_unchanged
-
\end_layout
\end_inset
-: formal (
+:
+ formal (
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-) style with horizontal lines only, using a bold top and bottom line, the
- first and last row are additionally separated from the table body with
- a thin middle line.
+) style with horizontal lines only,
+ using a bold top and bottom line,
+ the first and last row are additionally separated from the table body with a thin middle line.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1554308087
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1554308042
Formal_without_Footline
-\change_unchanged
-
\end_layout
\end_inset
-: same as the above, but the last row is not separated with a middle line
- from the body.
+:
+ same as the above,
+ but the last row is not separated with a middle line from the body.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1553618031
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553618006
Simple_Grid
-\change_unchanged
-
\end_layout
\end_inset
-: Simple table lines.
+:
+ Simple table lines.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1553618309
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553618031
Grid_with_Head
-\change_unchanged
-
\end_layout
\end_inset
-: Like
+:
+ Like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553618043
Simple_Grid
-\change_unchanged
-
\end_layout
\end_inset
-, but with the header
-\change_deleted 34634807 1619712593
-column
-\change_inserted 34634807 1619712594
-row
-\change_inserted -712698321 1553618309
- offset with a second horizontal line.
+,
+ but with the header row offset with a second horizontal line.
This is also the default style of \SpecialChar LyX
.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1553618280
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1553618261
No_Borders
-\change_unchanged
-
\end_layout
\end_inset
-: Table without lines.
-\change_unchanged
-
+:
+ Table without lines.
\end_layout
\end_deeper
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
+] The list of available font sizes for the document's main font,
+ separated by
\begin_inset Quotes eld
\end_inset
\end_inset
.
-
-\change_inserted -712698321 1565110196
Any number is possible.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1565110259
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565110199
FontSizeFormat
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565110196
string
-\change_unchanged
-
\end_layout
\end_inset
] The format for the font size option.
- Default:
+ Default:
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565110238
$$spt
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565110248
$$s
-\change_unchanged
-
\end_layout
\end_inset
is a placeholder for the font size.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Description
-
-\change_deleted 5863208 1594239483
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Header
-\end_layout
-
-\end_inset
-
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.: PUBLIC
-\begin_inset Quotes eld
-\end_inset
-
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
-\end_inset
-
-.
-\change_inserted -712698321 1565101761
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1565180598
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565101918
PageSize
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565105399
string="letter|\SpecialChar allowbreak
legal|\SpecialChar allowbreak
executive|\SpecialChar allowbreak
b6|\SpecialChar allowbreak
c0|\SpecialChar allowbreak
c1|\SpecialChar allowbreak
-c
-2|\SpecialChar allowbreak
+c2|\SpecialChar allowbreak
c3|\SpecialChar allowbreak
c4|\SpecialChar allowbreak
c5|\SpecialChar allowbreak
b4j|\SpecialChar allowbreak
b5j|\SpecialChar allowbreak
b6j"
-\change_unchanged
-
\end_layout
\end_inset
-] The list of available page sizes, separated by
+] The list of available page sizes,
+ separated by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565101779
|
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
.
- Currently, only the listed sizes are supported.
+ Currently,
+ only the listed sizes are supported.
Other sizes might be entered as custom class option.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1565180623
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565180605
PageSizeFormat
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565180601
string
-\change_unchanged
-
\end_layout
\end_inset
] The format for the page size option.
- Default:
+ Default:
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565180618
$$spaper
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565180601
$$s
-\change_unchanged
-
\end_layout
\end_inset
is a placeholder for the paper size.
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
] The list of available page sty\SpecialChar softhyphen
-les, separated by
+les,
+ separated by
\begin_inset Quotes eld
\end_inset
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+] Some document class options,
+ separated by a comma,
+ that will be added to the optional part of the
\begin_inset Flex Code
status collapsed
=""] This paragraph will appear in the table of contents of the given type.
An empty string disables.
See also the OutlinerName and the IsTocCaption commands.
- Default: disabled.
+ Default:
+ disabled.
\end_layout
\begin_layout Description
\emph on
block
\emph default
-, left, right, center
+,
+ left,
+ right,
+ center
\end_layout
\end_inset
\emph on
block
\emph default
-, left, right, center
+,
+ left,
+ right,
+ center
\end_layout
\end_inset
] A comma separated list of permitted alignments.
(Some \SpecialChar LaTeX
- styles prohibit certain alignments, since those wouldn't make sense.
+ styles prohibit certain alignments,
+ since those wouldn't make sense.
For example a right-aligned or centered enumeration isn't possible.)
\end_layout
\end_inset
] Defines argument number <int> of a command\SpecialChar breakableslash
-environment associated with
- the current style.
-
-\change_inserted -584632292 1615846868
+environment associated with the current style.
The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846867
EndArgument
-\change_unchanged
-
\end_layout
\end_inset
.
-
-\change_unchanged
-
-\change_inserted -584632292 1615846880
-See
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Arguments"
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for more information.
-\change_deleted -584632292 1615846694
-This is useful for things like section headings, and only makes sense with
- \SpecialChar LaTeX
-.
- Every (optional or required) argument of a command or environment – except
- for the required argument that is associated with the content of the paragraph
- itself – has a separate definition, where the number specifies the order
- of the arguments.
- The definition must end with
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndArgument
+AutoNests
\end_layout
\end_inset
-.
- So a command with two optional arguments has:
-\end_layout
-
-\begin_deeper
-\begin_layout Quote
-
-\change_deleted -584632292 1615846694
-
-\family typewriter
-Argument 1
-\end_layout
-
-\begin_layout Quote
-
-\change_deleted -584632292 1615846694
-
-\family typewriter
-...
-\end_layout
-
-\begin_layout Quote
-
-\change_deleted -584632292 1615846694
-
-\family typewriter
-EndArgument
-\end_layout
-
-\begin_layout Quote
-
-\change_deleted -584632292 1615846694
-
-\family typewriter
-Argument 2
-\end_layout
+ Includes a comma-separated list of layouts that should be nested in and after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Quote
-\change_deleted -584632292 1615846694
+\begin_inset Flex Code
+status collapsed
-\family typewriter
-...
+\begin_layout Plain Layout
+EndAutoNests
\end_layout
-\begin_layout Quote
-
-\change_deleted -584632292 1615846694
+\end_inset
-\family typewriter
-EndArgument
-\end_layout
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-\change_deleted -584632292 1615846694
-Inside the
+.
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+IsAutoNestedBy
\end_layout
\end_inset
- definition, the following specifications are possible:
+.
\end_layout
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+BabelPreamble
\end_layout
\end_inset
-
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+BabelPreamble
\end_layout
\end_inset
- The string that will appear both in the menu (to insert this argument)
- and on the argument inset button (unless you also specify a separate
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MenuString
+EndBabelPreamble
\end_layout
\end_inset
-).
- For the menu, you can define an accelerator by appending the respective
- character to the string, divided by
-\begin_inset Quotes eld
-\end_inset
-
-|
-\begin_inset Quotes erd
-\end_inset
-
- (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Short Title|S
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MenuString
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- A separate string for the menu.
- You can define an accelerator by appending the respective character to
- the string, divided by
-\begin_inset Quotes eld
-\end_inset
-
-|
-\begin_inset Quotes erd
-\end_inset
-
- (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Short Title|S
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-).
- This specification is optional.
- If it is not given the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
-\end_layout
-
-\end_inset
-
- will be used instead for the menu.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Tooltip
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- A longer explanatory text that appears in the tooltip when hovering over
- the argument inset.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Mandatory
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
-\end_inset
-
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-
-] Declare if this is a mandatory (1) or an optional (0) argument.
- Mandatory arguments will be output empty if not given, while optional arguments
- will not be output at all.
- By default, mandatory arguments are delimited by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-{...}
-\end_layout
-
-\end_inset
-
-, while optional arguments are delimited by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[...]
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1555579780
-NewlineCmd
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1555579780
-[string]
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- Option to define a different command (from the default
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1555579780
-
-\backslash
-
-\backslash
-
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-) to be used for line breaks.
- The initial backslash must not be specified.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Requires
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[int=0]
-\end_layout
-
-\end_inset
-
- defines another argument (by its number) which this argument requires to
- be output if it is itself output.
- E.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., in \SpecialChar LaTeX
- commands, optional arguments often require previous optional arguments
- to be output (at least empty), as in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-command[][argument]{text}
-\end_layout
-
-\end_inset
-
-.
- This can be achieved by the statement
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Requires 1
-\end_layout
-
-\end_inset
-
- within
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Argument 2
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LeftDelim
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- defines a custom left delimiter (instead of
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-{
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[
-\end_layout
-
-\end_inset
-
-).
- A line break in the output can be indicated by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<br/>
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-RightDelim
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- defines a custom right delimiter (instead of
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-}
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-]
-\end_layout
-
-\end_inset
-
-).
- A line break in the output can be indicated by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<br/>
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-DefaultArg
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- defines an argument that is inserted if and only if no user-specified arguments
- were given, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-e.
-\begin_inset space \space{}
-\end_inset
-
-if no argument inset has been inserted (note that also an empty argument
- inset omits the DefaultArg).
- Multiple arguments need to be separated by comma.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-PresetArg
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
-
-\end_inset
-
- defines an argument that is inserted in any case (alone or in addition
- to user-specified arguments).
- Multiple arguments need to be separated by comma.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Font
-\end_layout
-
-\end_inset
-
- The font used for the argument content, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559484228
-FreeSpacing
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559484228
-
-\emph on
-0
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559484228
-1
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelFont
-\end_layout
-
-\end_inset
-
- The font used for the label; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Decoration
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Classic
-\emph default
-, Minimalistic, Conglomerate
-\end_layout
-
-\end_inset
-
-] describes the rendering style used for the inset's frame and buttons.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-AutoInsert
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[int=0]
-\end_layout
-
-\end_inset
-
- If this is set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-
-, this argument is automatically inserted when the respective style is selected.
-
-\change_deleted -712698321 1559484200
- Currently, only one argument per style\SpecialChar breakableslash
-layout can be automatically inserted.
-\change_deleted -584632292 1615846694
-
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559490711
-InsertOnNewline
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559490703
-[int=0]
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- If this is set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559490703
-1
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-, this argument will be inserted on a new line with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1559491402
-AutoInsert
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
- (only available within Flex insets).
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-InsertCotext
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-[int=0]
-\end_layout
-
-\end_inset
-
- If this is set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-
-, this argument will be inserted with a copy of the co-text (either selected
- text or the whole paragraph) as content.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-PassThru
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-inherited
-\emph default
-, true, false
-\end_layout
-
-\end_inset
-
-] Whether the contents of this argument should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
- By default, the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-PassThru
-\end_layout
-
-\end_inset
-
- status is inherited by the inset or paragraph layout the argument belongs
- to, true and false change the status for the given argument only.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-PassThruChars
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string of characters
-\end_layout
-
-\end_inset
-
-]
-\family typewriter
-
-\family default
-Defines individual characters
-\begin_inset Newline linebreak
-\end_inset
-
-that should be output in raw form, meaning without special translations
- that \SpecialChar LaTeX
- would require.
- Note that, contrary to PassThru, this needs to be explicitly defined for
- arguments.
- That is, arguments do not inherit PassThruChars from their parent inset
- or layout.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -584632292 1615846694
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-IsTocCaption
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
-\end_inset
-
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-
-] If this is set to 1, the argument will output its content in the corresponding
- item in the table of contents.
- See AddToToc.
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -584632292 1615846694
-By default, the text entered in the \SpecialChar LyX
- workarea in the respective layout is
- the last (mandatory) argument of a command if the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LatexType
-\end_layout
-
-\end_inset
-
- is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Command
-\end_layout
-
-\end_inset
-
-.
- However, arguments with the prefix
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-post:
-\end_layout
-
-\end_inset
-
- are output after this workarea argument.
- Note that post-argument numbering restarts at 1, so the first argument
- following the workarea argument is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-post:1
-\end_layout
-
-\end_inset
-
-.
- Post-arguments are ignored in any other
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LatexType
-\end_layout
-
-\end_inset
-
- than
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Command
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -584632292 1615846694
-Arguments for list
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-item
-\end_layout
-
-\end_inset
-
-s (as in
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-item[foo]
-\end_layout
-
-\end_inset
-
-) have the prefix
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-item:
-\end_layout
-
-\end_inset
-
- followed by the number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Argument item:1
-\end_layout
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Standard
-
-\change_deleted -584632292 1615846694
-Finally, there is a special argument type with the prefix
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1534487844
-listpreamble:
-\change_unchanged
-
-\end_layout
-
-\end_inset
-
-.
- It is not really an argument, but uses the argument interface (thus, the
- prefix is also followed by a number, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1534488412
-Argument listpreamble:1
-\change_unchanged
-
-\end_layout
+\begin_inset Quotes erd
\end_inset
-).
- As the name implies, it is targeted at lists such as
-\family sans
-Itemize
-\family default
-,
-\family sans
-Enumerate
-\family default
-,
-\family sans
-Description
-\family default
-, or
-\family sans
-Bibliography
-\family default
.
- Its content will be output at the list start, before the first
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1534488058
-
-\backslash
-item
-\change_unchanged
-
-\end_layout
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+nolink "false"
\end_inset
-, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
-).
- This way, users can insert redefinitions (of lengths etc.) to individual
- lists.
- By default, these arguments do not have a delimiter.
-\change_unchanged
-
+ for details on its use.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AutoNests
+BottomSep
\end_layout
\end_inset
- Includes a comma-separated list of layouts that should be nested in and
- after the current layout.
- Only makes sense for nestable layouts (such as environments).
- Must be ended by
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndAutoNests
+float=0
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See also
-\begin_inset Flex Code
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-IsAutoNestedBy
+Note that a `float' here is a real number,
+ such as:
+ 1.5.
\end_layout
\end_inset
-.
+ The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
+ If the next paragraph has another style,
+ the separations are not simply added,
+ but the maximum is taken.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-
-\end_inset
-
- Note that this will completely override any prior
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-BabelPreamble
+Category
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+string
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
-
-\end_inset
-
- for details on its use.
+] The category for this style.
+ This is used to group related styles in the style combobox on the toolbar.
+ Any string can be used,
+ but you may want to use existing categories with your own styles.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BottomSep
+CopyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
-\end_layout
-
-\end_inset
-
-]
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+string
\end_layout
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- style is separated from the following paragraph.
- If the next paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+] Copies all the features of an existing style into the current one.
+ Note that this copies the style as it is defined at that point.
+ Later changes to it will not affect styles into which it has been copied.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Category
+DependsOn
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<name>
\end_layout
\end_inset
-] The category for this style.
- This is used to group related styles in the style combobox on the toolbar.
- Any string can be used, but you may want to use existing categories with
- your own styles.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
+] The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-CommandDepth
+Note that,
+ besides that functionality,
+ there is no way to ensure any ordering of preambles.
+ The ordering that you see in a given version of \SpecialChar LyX
+ may change without warning in later versions.
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CopyStyle
+DocBookGenerateTitle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+bool=false
\end_layout
\end_inset
-] Copies all the features of an existing style into the current one.
-
-\end_layout
-
-\begin_layout Description
+] Generates a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+title
\end_layout
\end_inset
- [
+ tag after the wrapper tag.
+ This parameter should only be used with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+DocBookWrapperTag
\end_layout
\end_inset
-] The name of a style whose preamble should be output
+,
+ otherwise the title will be output
\emph on
-before
+ before
\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+ the contents of the environment.
+ The generated title is the same as the LyXHTML label:
+ a combination of the environment type and its number.
+ A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of \SpecialChar LyX
- may change without warning
- in later versions.
+figure
\end_layout
\end_inset
-
+,
+ which requires a title although there is none in LaTeX.
+ This feature is heavily used for theorem-like environments.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+EndLabelType
\end_layout
\end_inset
\emph on
No_Label
\emph default
-, Box, Filled_Box, Static
+,
+ Box,
+ Filled_Box,
+ Static
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\begin_inset space ~
\end_inset
-black) square suitable for end of proof markers,
+black) square suitable for end of proof markers,
+
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
versions.
The first stable version that supports this tag is \SpecialChar LyX
2.1.0.
- The argument is a number which may either be 0, -1 or any value greater
- than zero.
+ The argument is a number which may either be 0,
+ -1 or any value greater than zero.
If the
\begin_inset Flex Code
status collapsed
\end_inset
- flag of a style is greater than zero, it will always be written to the
- document header.
- If a .lyx file is read, the style definitions from the document header are
- added to the document class.
+ flag of a style is greater than zero,
+ it will always be written to the document header.
+ If a .lyx file is read,
+ the style definitions from the document header are added to the document class.
Therefore even older \SpecialChar LyX
versions can handle the style.
The argument of
\end_inset
- is a version number: if the style is read, and the version number is less
- than the version number of the already existing style in the document class,
+ is a version number:
+ if the style is read,
+ and the version number is less than the version number of the already existing style in the document class,
the new style is ignored.
- If the version number is greater, the new style replaces the existing style.
- A value of -1 means an infinite version number, i.
+ If the version number is greater,
+ the new style replaces the existing style.
+ A value of -1 means an infinite version number,
+ i.
\begin_inset space \thinspace{}
\end_inset
] Usually \SpecialChar LyX
does not 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 \SpecialChar LaTeX
+ 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 \SpecialChar LaTeX
code.
- For this reason,
+ For this reason,
+
\begin_inset Flex Code
status collapsed
\end_inset
can be enabled.
-
-\change_deleted -495245474 1550490105
-Note that
-\change_unchanged
-\SpecialChar LyX
- will create protected blanks for the additional blanks when
-\change_deleted 34634807 1619626461
- in
-\change_unchanged
-
-\change_inserted -495245474 1550490096
-
+ \SpecialChar LyX
+ will create non-breaking spaces for the additional blanks when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -495245474 1550490089
Passthru 1
-\change_unchanged
-
\end_layout
\end_inset
is not specified.
-\change_deleted -495245474 1550490116
-another mode than \SpecialChar LaTeX
--mode.
-
-\change_inserted -495245474 1550247760
Note that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -495245474 1550247736
FreeSpacing
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -495245474 1550247755
KeepEmpty
-\change_unchanged
-
\end_layout
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Style-XHTML"
+nolink "false"
\end_inset
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-InnerTag
-\end_layout
-
-\end_inset
-
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
InPreamble
\end_layout
\end_inset
-, marks the style as to be included in the document preamble and not in
- the document body.
- This is useful for document classes that want such information as the title
- and author to appear in the preamble.
+,
+ marks the style as to be included in the document preamble and not in the document body.
+ This is useful for document classes that want such information as the title and author to appear in the preamble.
Note that this works only for styles for which the
\begin_inset Flex Code
status collapsed
\end_inset
-, marks the style as being part of a title block (see also the
+,
+ marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\end_inset
- Includes a comma-separated list of layouts after which this one should
- be nested.
+ Includes a comma-separated list of layouts after which this one should be nested.
Only makes sense with regard to nestable layouts (such as environments).
Must be ended by
\begin_inset Quotes eld
\end_inset
-] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
- of its contents in its item in the table of contents.
- Otherwise, only the label, if it exists, appears.
+] If this is set to 1 and AddToToc is enabled,
+ the paragraph adds a summary of its contents in its item in the table of contents.
+ Otherwise,
+ only the label,
+ if it exists,
+ appears.
\end_layout
\begin_layout Description
] The \SpecialChar LaTeX
command sequence declaring an item in a list.
- The command is to be defined without the preceding backslash (the default
- is
+ The command is to be defined without the preceding backslash (the default is
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, resulting in
+,
+ resulting in
\begin_inset Flex Code
status collapsed
\end_inset
] This provides extra space between paragraphs that have the same style.
- If you put other styles into an environment, each is separated with the
- environment's
+ If you put other styles into an environment,
+ each is separated with the environment's
\begin_inset Flex Code
status collapsed
\end_inset
.
- But the whole items of the environment are additionally separated with
- this
+ But the whole items of the environment are additionally separated with this
\begin_inset Flex Code
status collapsed
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-ItemTag
-\end_layout
-
-\end_inset
-
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
KeepEmpty
\end_layout
\end_inset
] Usually \SpecialChar LyX
- does not allow you to leave a paragraph empty, since it would
- lead to empty \SpecialChar LaTeX
+ does not allow you to leave a paragraph empty,
+ since it would lead to empty \SpecialChar LaTeX
output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a style can be used
- as some kind of break, which does not contain actual text.
+ There are some cases where this could be desirable however:
+ in a letter template,
+ the required fields can be provided as empty fields,
+ so that people do not forget them;
+ in some special classes,
+ a style can be used as some kind of break,
+ which does not contain actual text.
\end_layout
\begin_layout Description
\end_inset
] The name of the counter for automatic numbering.
- In order to have the counter appear with your label, you will need to reference
- it in the
+ In order to have the counter appear with your label,
+ you will need to reference it in the
\begin_inset Flex Code
status collapsed
\end_inset
-s,
+s,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, at least.
+,
+ at least.
\begin_inset Newline newline
\end_inset
\end_inset
-, though this case is a bit complicated.
+,
+ though this case is a bit complicated.
Suppose you declare
\begin_inset Quotes eld
\end_inset
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, much as in \SpecialChar LaTeX
+,
+ much as in \SpecialChar LaTeX
.
These counters must all be declared separately.
\begin_inset Newline newline
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Counters"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_inset
-] Text that indicates the amount of horizontal space between the label and
- the text body.
+] Text that indicates the amount of horizontal space between the label and the text body.
Only used for labels that are not above the text body.
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in
+ is set,
+ this string can be contain the special formatting commands described in
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Counters"
+nolink "false"
\end_inset
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-LabelTag
-\end_layout
-
-\end_inset
-
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
LabelType
\end_layout
\emph on
No_Label
\emph default
-, Manual, Static, Above,
+,
+ Manual,
+ Static,
+ Above,
+
\begin_inset Newline newline
\end_inset
-Centered, Sensitive, Enumerate,
+Centered,
+ Sensitive,
+ Enumerate,
\begin_inset Newline newline
\end_inset
-Itemize, Bibliography
+Itemize,
+ Bibliography
\end_layout
\end_inset
\end_inset
means the label is the very first word (up to the first real blank).
- Use protected spaces if you want more than one word as the label.
+ Use non-breaking spaces if you want more than one word as the label.
\end_layout
\begin_inset Quotes erd
\end_inset
-, at the beginning of the paragraph.
+,
+ at the beginning of the paragraph.
If the
\begin_inset Flex Code
status collapsed
\end_inset
-, then it will be displayed only in the first paragraph of any sequence
- of paragraphs with the same
+,
+ then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
\begin_inset Flex Code
status collapsed
\end_inset
.
- The label will be printed above the paragraph either at the beginning of
- the line or centered.
+ The label will be printed above the paragraph either at the beginning of the line or centered.
\end_layout
\begin_layout Description
\end_inset
- means the (hardcoded) label string depends on the kind of float: It is
- hardcoded to be `FloatType N', where N is the value of the counter associated
- with the float.
+ means the (hardcoded) label string depends on the kind of float:
+ It is hardcoded to be `FloatType N',
+ where N is the value of the counter associated with the float.
For the case that a caption is inserted outside of a float the
\begin_inset Flex Code
status collapsed
\family sans
Counter
\family default
-, see
+,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Counters"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
+nolink "false"
\end_inset
\emph on
Paragraph
\emph default
-, Command, Environment, Item_Environment,
+,
+ Command,
+ Environment,
+ Item_Environment,
\begin_inset Newline newline
\end_inset
-List_Environment, Bib_Environment
+List_Environment,
+ Bib_Environment
\end_layout
\end_inset
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ is perhaps a bit misleading,
+ since these rules apply to SGML classes,
+ too.
Visit the SGML class files for specific examples.
\end_layout
\end_inset
-, except that an
+,
+ except that an
\begin_inset Flex Code
status collapsed
\end_inset
-, except that
+,
+ except that
\begin_inset Newline newline
\end_inset
\end_inset
- but adds the necessary mandatory argument (the longest label) to the begin
- statement of the bibliography environment:
+ but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
\begin_inset Newline newline
\end_inset
\begin_inset Quotes erd
\end_inset
- can be changed by the user in the paragraph settings of a bibliography
- item.
+ can be changed by the user in the paragraph settings of a bibliography item.
\end_layout
\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
+Putting the last few things together,
+ the \SpecialChar LaTeX
+ output will be either:
+
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-or:
+or:
+
\end_layout
\begin_layout LyX-Code
\end_inset
-] If you put styles into environments, the different
+] If you put styles into environments,
+ the different
\begin_inset Flex Code
status collapsed
\end_inset
- are not simply added, but added with a factor
+ are not simply added,
+ but added with a factor
\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
\end_inset
\end_inset
.
- This way was chosen so that the look is the same with each used screen
- font.
+ This way was chosen so that the look is the same with each used screen font.
\end_layout
\begin_layout Description
\emph on
Static
\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+,
+ Manual,
+ Dynamic,
+ First_Dynamic,
+ Right_Address_Box
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, even if standard
+,
+ even if standard
\begin_inset Quotes eld
\end_inset
\end_inset
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
+ is similar,
+ but only the very first row of the paragraph is dynamic,
+ while the others are static;
+ this is used,
+ for example,
+ for descriptions.
\end_layout
\begin_layout Description
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
+ means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
This is used to typeset an address on the right edge of the page.
\end_layout
\end_inset
'ed.
- (Note: This is
+ (Note:
+ This is
\emph on
not
\emph default
whether this command should itself be protected.)
-\change_inserted -712698321 1523696949
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1552395557
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523696950
NeedCProtect
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+-1
+\end_layout
+
+\end_inset
-\change_inserted -712698321 1523696950
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523696950
1
-\change_unchanged
-
\end_layout
\end_inset
-] This causes macros that contain this layout to be protected with
+] Value
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+1
+\end_layout
-\change_inserted -712698321 1523696950
+\end_inset
+
+ causes macros that contain this layout to be protected with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
cprotect
-\change_unchanged
-
\end_layout
\end_inset
cprotect
\family default
) if necessary and thus allows (some) verbatim stuff in macros.
+ With the default setting (value
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
\end_layout
-\begin_layout Description
+\end_inset
-\change_inserted -712698321 1552395844
+),
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1552395561
-NeedMBoxProtect
-\change_unchanged
+\backslash
+cprotect
+\end_layout
+
+\end_inset
+
+ is used if a nested element requires it.
+ Value
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+-1
\end_layout
\end_inset
- [
+ prevents any use of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cprotect
+\end_layout
+
+\end_inset
+
+ within this layout,
+ even if required by a nested element.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+NeedMBoxProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1552395557
+\begin_layout Plain Layout
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1552395557
1
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395655
-
\backslash
cite
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395661
-
\backslash
ref
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395631
-
\backslash
mbox
-\change_unchanged
-
\end_layout
\end_inset
soul
\family default
commands which parse their content in complex ways.
-\change_unchanged
-
\end_layout
\begin_layout Description
) or not.
The translation can be switched off to allow more comfortable \SpecialChar LaTeX
- editing
- inside \SpecialChar LyX
+ editing inside \SpecialChar LyX
.
\end_layout
\end_inset
-] If set to true, and if
+] If set to true,
+ and if
\begin_inset Flex Code
status collapsed
\end_inset
-) paragraphs are being indented, then the indentation of such a paragraph
- following one of this type will be suppressed.
+) paragraphs are being indented,
+ then the indentation of such a paragraph following one of this type will be suppressed.
(So this will not affect the display of non-default paragraphs.)
\end_layout
\end_inset
] Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
+ This is used to rename a style,
+ while keeping backward compatibility.
\end_layout
\begin_layout Description
\end_inset
-] Determines whether consecutive paragraphs of the same type are treated
- as belonging together.
+] Determines whether consecutive paragraphs of the same type are treated as belonging together.
This has the effect that the
\begin_inset Flex Code
status collapsed
\end_inset
is only printed once before such a group.
- By default, this is true for
+ By default,
+ this is true for
\begin_inset Flex Code
status collapsed
] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
output,
- but only by a line break; together with
+ but only by a line break;
+ together with
\begin_inset Flex Code
status collapsed
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+,
+ this allows to emulate a plain text editor (like the ERT inset).
\end_layout
\begin_layout Description
\end_inset
will be fixed for a certain style.
- The exception is the default style, since the indentation for these paragraphs
- can be prohibited with
+ The exception is the default style,
+ since the indentation for these paragraphs can be prohibited with
\begin_inset Flex Code
status collapsed
\end_inset
.
- Also,
+ Also,
+
\begin_inset Flex Code
status collapsed
\end_inset
- of the environment, not their native one.
- For example,
+ of the environment,
+ not their native one.
+ For example,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
- is chosen,
+ is chosen,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
- is chosen,
+ is chosen,
+
\begin_inset Flex Code
status collapsed
\end_inset
is the height of a row with the normal font.
- This way, the look stays the same with different screen fonts.
+ This way,
+ the look stays the same with different screen fonts.
\end_layout
\begin_layout Description
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+] Whether the contents of this paragraph should be output in raw form,
+ meaning without special translations that \SpecialChar LaTeX
would require.
\end_layout
\family typewriter
\family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+Defines individual characters that should be output in raw form,
+ meaning without special translations that \SpecialChar LaTeX
would require.
\end_layout
Information to be included in the \SpecialChar LaTeX
preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
+ Used to define macros,
+ load packages,
+ etc.,
+ required by this particular style.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
+] The prefix to use when creating labels referring to paragraphs of this type.
This allows the use of formatted references.
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:List-of-functions"
+nolink "false"
\end_inset
for the list of features).
- If you require a package with specific options, you can additionally use
-
+ If you require a package with specific options,
+ you can additionally use
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:General-text-class"
+nolink "false"
\end_inset
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
+,
+ but you do not want to inherit its (required and optional) arguments.
\end_layout
\begin_layout Description
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ correspond respectively to a multiplier value of 1,
+ 1.25 and 1.667.
If you specify the argument
\begin_inset Flex Code
status collapsed
\end_inset
-, then you must also provide a value argument which will be the actual multiplie
-r value.
- Note that, contrary to other parameters,
+,
+ then you must also provide a value argument which will be the actual multiplier value.
+ Note that,
+ contrary to other parameters,
+
\begin_inset Flex Code
status collapsed
\end_inset
implies the generation of specific \SpecialChar LaTeX
- code, using the \SpecialChar LaTeX
+ code,
+ using the \SpecialChar LaTeX
package
\family roman
status collapsed
\begin_layout Plain Layout
-Step
-\change_deleted 731793113 1604355211
-Master
-\change_inserted 731793113 1604355212
-Parent
-\change_unchanged
-Counter
+StepParentCounter
\end_layout
\end_inset
\end_inset
-] Steps the
-\change_deleted 731793113 1604355214
-master
-\change_inserted 731793113 1604355216
-parent
-\change_unchanged
- counter of a given counter at the beginning of a new sequence of layouts.
+] Steps the parent counter of a given counter at the beginning of a new sequence of layouts.
This is currently only useful when
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\emph default
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-] This tag determines whether the first line indentation of this paragraph
- can be toggled via the Paragraph settings dialog.
+] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
If
\emph on
\emph default
- is set, indentation can be toggled if the document settings use
+ is set,
+ indentation can be toggled if the document settings use
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- paragraph style, with
+ paragraph style,
+ with
\begin_inset Flex Code
status collapsed
\end_inset
-, indentation can always be toggled, notwithstanding the document settings,
+,
+ indentation can always be toggled,
+ notwithstanding the document settings,
with
\begin_inset Flex Code
status collapsed
\end_inset
-, indentation can never be toggled.
+,
+ indentation can never be toggled.
\end_layout
\begin_layout Description
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this style is separated from the previous paragraph.
- If the previous paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
+ If the previous paragraph has another style,
+ the separations are not simply added,
+ but the maximum is taken.
\end_layout
\begin_layout Subsection
\begin_layout Standard
\SpecialChar LyX
- has long supported internationalization of layout information, but, until
- version 2.0, this applied only to the user interface and not to, say, PDF
- output.
- Thus, French authors were forced to resort to ugly hacks if they wanted
- `
+ has long supported internationalization of layout information,
+ but,
+ until version 2.0,
+ this applied only to the user interface and not to,
+ say,
+ PDF output.
+ Thus,
+ French authors were forced to resort to ugly hacks if they wanted `
\lang french
Théorème
\lang english
1' instead of `Theorem 1'.
- Thanks to Georg Baum, that is no longer the case.
+ Thanks to Georg Baum,
+ that is no longer the case.
\end_layout
\begin_layout Standard
\end_inset
- defines text that is to appear in the typeset document, it may use
+ defines text that is to appear in the typeset document,
+ it may use
\begin_inset Flex Code
status collapsed
\end_deeper
\begin_layout Standard
-In principle, any legal \SpecialChar LaTeX
+In principle,
+ any legal \SpecialChar LaTeX
may appear in the
\begin_inset Flex Code
status collapsed
\end_inset
- tags, but in practice they will typically look as they do here.
- The key to correct translation of the typeset text is the definition of
- the \SpecialChar LaTeX
+ tags,
+ but in practice they will typically look as they do here.
+ The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
command
\begin_inset Flex Code
status collapsed
\end_inset
- tag provides for internationalization based upon the overall language of
- the document.
- The contents of the tag will be included in the preamble, just as with
- the
+ tag provides for internationalization based upon the overall language of the document.
+ The contents of the tag will be included in the preamble,
+ just as with the
\begin_inset Flex Code
status collapsed
\end_inset
-, which will be replaced, when \SpecialChar LyX
+,
+ which will be replaced,
+ when \SpecialChar LyX
produces \SpecialChar LaTeX
- output, with the translation of
- its argument into the document language.
+ output,
+ with the translation of its argument into the document language.
\end_layout
\begin_layout Standard
\end_inset
- tag is more complex, since it is meant to provide support for multi-language
- documents and so offers an interface to the
+ tag is more complex,
+ since it is meant to provide support for multi-language documents and so offers an interface to the
\begin_inset Flex Code
status collapsed
\end_inset
package.
- Its contents will be added to the preamble once for each language that
- appears in the document.
- In this case, the argument to
+ Its contents will be added to the preamble once for each language that appears in the document.
+ In this case,
+ the argument to
\begin_inset Flex Code
status collapsed
\end_inset
- will be replaced with its translation into the language in question; the
- expression
+ will be replaced with its translation into the language in question;
+ the expression
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
+A German document that also included a French section would thus have the following in the preamble:
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-One important point to note here is that the translations are provided by
- \SpecialChar LyX
- itself, through the file
+One important point to note here is that the translations are provided by \SpecialChar LyX
+ itself,
+ through the file
\begin_inset Flex Code
status collapsed
\end_inset
.
- This means, in effect, that
+ This means,
+ in effect,
+ that
\begin_inset Flex Code
status collapsed
\end_inset
are really only of use in layout files that are provided with \SpecialChar LyX
-, since text
- entered in user-created layout files will not be seen by \SpecialChar LyX
-'s internationalizatio
-n routines unless the
+,
+ since text entered in user-created layout files will not be seen by \SpecialChar LyX
+'s internationalization routines unless the
\begin_inset Flex Code
status collapsed
\end_inset
file is modified accordingly.
- That said, however, any layout created with the intention that it will
- be included with \SpecialChar LyX
+ That said,
+ however,
+ any layout created with the intention that it will be included with \SpecialChar LyX
should use these tags where appropriate.
Please note that the paragraph style translations provided by \SpecialChar LyX
- will never
- change with a minor update (e.
+ will never change with a minor update (e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
-,
+,
+
\begin_inset Flex Noun
status collapsed
\end_inset
-, \SpecialChar ldots
+,
+ \SpecialChar ldots
) in the text class itself.
Standard floats are included in the file
\begin_inset Flex Code
\end_inset
-, so you may have to do no more than add
+,
+ so you may have to do no more than add
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with \SpecialChar LyX
-), the information below will hopefully
- help you:
+ If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
+),
+ the information below will hopefully help you:
\end_layout
\begin_layout Description
=!htbpH] Allowed placement options for this float type.
The value is a string of placement characters.
- Possible characters include:
+ Possible characters include:
+
\emph on
h
\emph default
\begin_inset Quotes erd
\end_inset
-),
+),
+
\emph on
t
\emph default
\begin_inset Quotes erd
\end_inset
-),
+),
+
\emph on
b
\emph default
\begin_inset Quotes erd
\end_inset
-),
+),
+
\emph on
p
\emph default
\begin_inset Quotes erd
\end_inset
-),
+),
+
\emph on
H
\emph default
) and
\emph on
!
+
\emph default
(
\begin_inset Quotes eld
).
The order of the characters in the string does not matter.
- If no placement options are allowed, use the string
+ If no placement options are allowed,
+ use the string
\emph on
none
\emph default
\emph default
-] Defines whether the float has a starred variant that spans columns in
- a two column paragraph.
+] Defines whether the float has a starred variant that spans columns in a two column paragraph.
Set to
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
+] The file name extension of an auxiliary file for the list of figures (or whatever).
\SpecialChar LaTeX
writes the captions to this file.
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Tags-for-XHTML"
+nolink "false"
\end_inset
\end_inset
-] Indicates whether the float is already defined in the document class or
- if instead the \SpecialChar LaTeX
+] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
package
\begin_inset Flex Code
status collapsed
\end_inset
-, which means:
+,
+ which means:
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-] The command used to generate a list of floats of this type; the leading
- `
+] The command used to generate a list of floats of this type;
+ the leading `
\backslash
' must be omitted.
This
\end_inset
- is false, since there is no standard way to generate this command.
+ is false,
+ since there is no standard way to generate this command.
It is ignored if
\begin_inset Flex Code
status collapsed
\end_inset
- is true, since in that case there is a standard way to define the command.
+ is true,
+ since in that case there is a standard way to define the command.
\end_layout
\begin_layout Description
\begin_inset Quotes erd
\end_inset
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
+] A title for a list of floats of this kind (list of figures,
+ tables,
+ or whatever).
It is used for the screen label within \SpecialChar LyX
-, it is used by \SpecialChar LaTeX
- for the title and
- it is used as the title in the XHTML output.
+,
+ it is used by \SpecialChar LaTeX
+ for the title and it is used as the title in the XHTML output.
It will be translated to the document language.
\end_layout
\begin_inset Quotes erd
\end_inset
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if
+] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
+ For example,
+ if
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-, the floats will be numbered within chapters.
+,
+ the floats will be numbered within chapters.
\end_layout
] The default placement for the given class of floats.
The string should be as in standard \SpecialChar LaTeX
-:
+:
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
- for top, bottom, page, and here, respectively.
+ for top,
+ bottom,
+ page,
+ and here,
+ respectively.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- \SpecialChar LaTeX
+Note that the order of these letters in the string is irrelevant,
+ like in \SpecialChar LaTeX
.
\end_layout
\end_inset
- On top of that there is a new type,
+ On top of that there is a new type,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, which does not really correspond to a float, since it means: put it
+,
+ which does not really correspond to a float,
+ since it means:
+ put it
\begin_inset Quotes eld
\end_inset
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-built in float types.
- If you do not understand what this means, just use
+ specifier is special and,
+ because of implementation details,
+ cannot be used in non-built in float types.
+ If you do not understand what this means,
+ just use
\begin_inset Quotes eld
\end_inset
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+PrettyFormat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A format for use with formatted references to this counter.
+ For example,
+ one might want to have references to tables appear as
+\begin_inset Quotes eld
+\end_inset
+
+Table 2
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The string may contain
+\begin_inset Quotes eld
+\end_inset
+
+##
+\begin_inset Quotes erd
+\end_inset
+
+ or a counter specification.
+ (See the documentation for
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ in
+\begin_inset CommandInset ref
+LatexCommand formatted
+reference "subsec:Counters"
+plural "false"
+caps "false"
+noprefix "false"
+nolink "false"
+
+\end_inset
+
+.) The former will be replaced by the counter number itself.
+ So,
+ for sections,
+ it would be:
+ Section ##,
+ or perhaps:
+ section
+\backslash
+arabic{section} (which might render as:
+ section 2.7).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
RefPrefix
\end_layout
\begin_inset Quotes erd
\end_inset
-, which must be all caps.
-\change_inserted -712698321 1565605014
-
+,
+ which must be all caps.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1565605014
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565605014
Requires
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1565605014
string
-\change_unchanged
-
\end_layout
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Description
\begin_inset Quotes erd
\end_inset
- of the new class of floats, like program or algorithm.
+ of the new class of floats,
+ like program or algorithm.
After the appropriate
\begin_inset Flex Code
status collapsed
\end_inset
-, commands such as
+,
+ commands such as
\begin_inset Flex Code
status collapsed
\end_inset
-, either by the class file, another package or on-the-fly by \SpecialChar LyX
+,
+ either by the class file,
+ another package or on-the-fly by \SpecialChar LyX
itself.
\end_layout
\end_layout
\begin_layout Standard
-Flex insets come in
-\change_deleted 5863208 1594239511
-three
-\change_inserted 5863208 1594239512
-two
-\change_unchanged
- different kinds:
+Flex insets come in two different kinds:
+
\end_layout
\begin_layout Itemize
\end_inset
-): These define semantic markup corresponding to such \SpecialChar LaTeX
+):
+ These define semantic markup corresponding to such \SpecialChar LaTeX
commands as
\begin_inset Flex Code
status collapsed
\end_inset
-): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
+):
+ These can be used to define custom collapsible insets,
+ similar to \SpecialChar TeX
code,
- footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
+ footnote,
+ and the like.
+ An obvious example is an endnote inset,
+ which is defined in the
\begin_inset Flex Code
status collapsed
\end_inset
- module.
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted 5863208 1594239528
-XML elements (
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Element
-\end_layout
-
-\end_inset
-
-): For use with DocBook classes.
-\change_unchanged
-
+ module.
\end_layout
\begin_layout Standard
\end_inset
- tag, which shall be explained in a moment.
+ tag,
+ which shall be explained in a moment.
\end_layout
\begin_layout Standard
\end_inset
- tag also serves another function: It can be used to customize the general
- layout of many different types of insets.
- Currently,
+ tag also serves another function:
+ It can be used to customize the general layout of many different types of insets.
+ Currently,
+
\begin_inset Flex Code
status collapsed
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, \SpecialChar TeX
- code (ERT) insets, branches, listings, indexes, boxes,
- tables, algorithms, URLs, and captions, as well as to define Flex insets.
+ can be used to customize the layout parameters for footnotes,
+ marginal notes,
+ note insets,
+ \SpecialChar TeX
+ code (ERT) insets,
+ branches,
+ listings,
+ indexes,
+ boxes,
+ tables,
+ algorithms,
+ URLs,
+ and captions,
+ as well as to define Flex insets.
\end_layout
\begin_layout Standard
\end_inset
- indicates the inset whose layout is being defined, and here there are four
- cases.
+ indicates the inset whose layout is being defined,
+ and here there are four cases.
\end_layout
\begin_layout Enumerate
The layout for a pre-existing inset is being modified.
- In this case, can be
+ In this case,
+ can be
\begin_inset Flex Code
status collapsed
\end_inset
- any one of the following:
+ any one of the following:
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, or
+,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Enumerate
The layout for a Flex inset is being defined.
- In this case,
+ In this case,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
may be any valid identifier not used by a pre-existing Flex inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
+ The identifier may include spaces,
+ but in that case the whole thing must be wrapped in quotes.
Note that the definition of a flex inset
\emph on
must
\end_inset
- entry, declaring which type of inset it defines.
+ entry,
+ declaring which type of inset it defines.
\end_layout
\begin_layout Enumerate
The layout for user specific branch is being defined.
- In this case,
+ In this case,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
may be any valid identifier of branch defined in user's document.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
+ The identifier may include spaces,
+ but in that case the whole thing must be wrapped in quotes.
The main purpose of this feature is to allow \SpecialChar LaTeX
- wrapping around specific
- branches as user needs.
+ wrapping around specific branches as user needs.
\end_layout
\begin_layout Enumerate
The layout of a user (or class) specific caption is being defined.
- In this case,
+ In this case,
+
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
-), the specific captions of the KOMA-Script classes (
+),
+ the specific captions of the KOMA-Script classes (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Caption:Above
+\end_layout
+
+\end_inset
+
+,
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Caption:Below
+\end_layout
+
+\end_inset
+
+) or the module
+\family sans
+Multilingual
+\begin_inset space ~
+\end_inset
+
+Captions
+\begin_inset Newline linebreak
+\end_inset
+
+
+\family default
+(
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Caption:Bicaption
+\end_layout
+
+\end_inset
+
+) for applications.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ definition can contain the following entries:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=""] This inset will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ This is only implemented for Flex insets.
+ Default:
+ disabled.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedInInsets
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of insets to which this inset can be inserted.
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAllowedInInsets
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If you you also want the insertion to be allowed in specific arguments of the target insets,
+ append the argument name after @ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+My_Inset@post:1
+\end_layout
+
+\end_inset
+
+).
+ Note that this currently only supports immediately containing insets (no deeper nesting).
+ See also
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedInLayouts
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedInLayouts
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts within which this inset can be inserted.
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndAllowedInLayouts
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Note that this currently only supports immediately containing layouts (no deeper nesting).
+ See also
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedInInsets
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedOccurrences
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int
+\end_layout
+
+\end_inset
+
+] If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AllowedInInsets
+\end_layout
+
+\end_inset
+
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Above
+AllowedInLayouts
\end_layout
\end_inset
-,
+ has been defined,
+ this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Below
+AllowedOccurrencesPerItem
\end_layout
\end_inset
-) or the module
-\family sans
-Multilingual
-\begin_inset space ~
-\end_inset
-
-Captions
-\begin_inset Newline linebreak
-\end_inset
-
-
-\family default
-(
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Bicaption
+
+\emph on
+0
\end_layout
\end_inset
-) for applications.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Standard
-The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+1
\end_layout
\end_inset
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
+] If this is set to true,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToToc
+AllowedOccurrences
\end_layout
\end_inset
- [
+ applies to single paragraphs if we are in a list-type environment (with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\backslash
+item
\end_layout
\end_inset
-=""] This inset will appear in the table of contents of the given type.
- An empty string disables.
- See also the OutlinerName and the IsTocCaption commands.
- This is only implemented for Flex insets.
- Default: disabled.
+s).
\end_layout
\begin_layout Description
\end_inset
] Defines argument number of a command\SpecialChar breakableslash
-environment associated with the current
- layout.
+environment associated with the current layout.
The definition must end with
\begin_inset Flex Code
status collapsed
.
See
-\change_inserted -584632292 1615846847
-
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Arguments"
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
-
-\change_deleted -584632292 1615846847
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-
-\change_unchanged
- for
-\change_deleted -584632292 1615846902
-details
-\change_inserted -584632292 1615846906
-more information
-\change_unchanged
-.
+ for more information.
\end_layout
\begin_layout Description
\end_inset
- Preamble for changing language commands; see
+ Preamble for changing language commands;
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:Names-of-colors"
+nolink "false"
\end_inset
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
+] Whether to use the content of the inset as the label,
+ when the inset is closed.
Default is false.
\end_layout
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
.
- Note that you need to specify the complete type, e.
+ Note that you need to specify the complete type,
+ e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
+] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
\end_layout
\begin_layout Description
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, or
+,
+ or
\begin_inset Flex Code
status collapsed
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
+,
+ describing the rendering style used for the inset's frame and buttons.
Footnotes generally use
\begin_inset Flex Code
status collapsed
\end_inset
-, ERT insets generally
+,
+ ERT insets generally
\begin_inset Flex Code
status collapsed
\end_inset
-, and character styles
+,
+ and character styles
\begin_inset Flex Code
status collapsed
\end_inset
.
- Indicates whether the environment will stand on its own in the output or
- will appear inline with the surrounding text.
- If set to false, it is supposed that the \SpecialChar LaTeX
- environment ignores white space
- (including one newline character) after the
+ Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
+ If set to false,
+ it is supposed that the \SpecialChar LaTeX
+ environment ignores white space (including one newline character) after the
\begin_inset Flex Code
status collapsed
tags.
Default is true.
-\change_inserted 731793113 1538674858
-
\end_layout
\begin_layout Description
-
-\change_inserted 731793113 1538674891
\begin_inset Flex Code
status open
\begin_layout Plain Layout
-
-\change_inserted 731793113 1538674863
EditExternal
-\change_unchanged
-
\end_layout
\end_inset
\emph on
0
\emph default
-,1] Allow the contents of the inset to be edited externally (using whatever
- editor is defined for the document's output format).
-\change_unchanged
-
+,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
\end_layout
\begin_layout Description
the label.
See
\begin_inset CommandInset ref
-LatexCommand ref
+LatexCommand formatted
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_inset
- to the same value, so define this first and define
+ to the same value,
+ so define this first and define
\begin_inset Flex Code
status collapsed
.
This setting is ignored if fully Unicode aware \SpecialChar LaTeX
backends such as Xe\SpecialChar TeX
- or
- Lua\SpecialChar TeX
+ or Lua\SpecialChar TeX
are used.
\end_layout
\end_inset
-] When using babel, always use a local font switch (
+] When using babel,
+ always use a local font switch (
\begin_inset Flex Code
status collapsed
\end_inset
-), never a global one (such as
+),
+ never a global one (such as
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
- language, leading to Left-to-Right (Latin) output, e.
+ language,
+ leading to Left-to-Right (Latin) output,
+ e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
] Force a line break in the \SpecialChar LaTeX
- output before the inset starts and after the
- inset ends.
- This assures the inset itself is output on its own lines, for parsing purposes.
+ output before the inset starts and after the inset ends.
+ This assures the inset itself is output on its own lines,
+ for parsing purposes.
\end_layout
\begin_layout Description
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
+ should be used or,
+ instead,
+ the user can change the paragraph style used in the inset.
Default is false.
\end_layout
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Tags-for-XHTML"
+nolink "false"
\end_inset
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+InheritFont
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
+ export if this parameter is 1,
+ as well as on screen.
+ Otherwise the document default font is used.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
InToc
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane for all table of contents, regardless of the AddToToc
- setting.
- 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.
+] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
+ regardless of the AddToToc setting.
+ 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
\end_inset
-] If this is set to 1 and AddToToc is enabled, the inset adds a summary
- of its contents in its item in the table of contents.
- Otherwise, only the label appears.
+] If this is set to 1 and AddToToc is enabled,
+ the inset adds a summary of its contents in its item in the table of contents.
+ Otherwise,
+ only the label appears.
\end_layout
\begin_layout Description
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_inset
-, lest it be ineffective.
+,
+ lest it be ineffective.
\end_layout
\begin_layout Description
\end_inset
- Language dependent preamble; see
+ Language dependent preamble;
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:I18n"
+nolink "false"
\end_inset
\end_inset
- stuff, including possible bracket pairs like
+ stuff,
+ including possible bracket pairs like
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-Command, Environment, None
+Command,
+ Environment,
+ None
\end_layout
\end_inset
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes too.
+ is perhaps a bit misleading,
+ since these rules apply to SGML classes too.
Visit the SGML class files for specific examples.
\end_layout
\end_layout
\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
+Putting the last few things together,
+ the \SpecialChar LaTeX
+ output will be either:
+
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-or:
+or:
+
\end_layout
\begin_layout LyX-Code
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
-\change_deleted -584632292 1615846609
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-element
-\end_layout
-
-\end_inset
-
-
-\change_unchanged
-or
+,
+ or
\begin_inset Flex Code
status collapsed
\end_inset
- (indicating a dummy definition ending definitions of charstyles, etc).
+ (indicating a dummy definition ending definitions of charstyles,
+ etc).
This entry is required in and is only meaningful for Flex insets.
- Among other things, it determines on which menu this inset will appear.
+ Among other things,
+ it determines on which menu this inset will appear.
Setting
\begin_inset Flex Code
status collapsed
\end_inset
- can be set to true, or
+ can be set to true,
+ or
\begin_inset Flex Code
status collapsed
\end_inset
- to false, for
+ to false,
+ for
\begin_inset Flex Code
status collapsed
\end_inset
.
-\change_inserted -712698321 1555575738
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1555575844
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1555575740
MenuString
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1555575740
[string]
-\change_unchanged
-
\end_layout
\end_inset
A dedicated string for the menu.
- You can define an accelerator by appending the respective character to
- the string, divided by
+ You can define an accelerator by appending the respective character to the string,
+ divided by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1555575781
My Inset|M
-\change_unchanged
-
\end_layout
\end_inset
).
This specification is optional.
- If it is not given the inset name as specified in the type declaration
- will be used instead for the menu.
-\change_unchanged
-
+ If it is not given the inset name as specified in the type declaration will be used instead for the menu.
\end_layout
\begin_layout Description
\end_inset
to the opposite value.
- These can be reset to other values, if they are used
+ These can be reset to other values,
+ if they are used
\emph on
after
\emph default
\end_inset
'ed.
- (Note: This is
+ (Note:
+ This is
\emph on
not
\emph default
whether the command should itself be protected.) Default is false.
-\change_inserted -712698321 1523633958
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1552395786
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523633961
NeedCProtect
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1523633958
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1523633958
1
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1523634038
-
\backslash
cprotect
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1555579651
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1552395787
NeedMBoxProtect
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395787
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1552395787
1
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395787
-
\backslash
cite
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395787
-
\backslash
ref
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1552395787
-
\backslash
mbox
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1555579742
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1555579658
NewlineCmd
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1555579651
[string]
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1555579742
-
\backslash
\backslash
-\change_unchanged
-
\end_layout
\end_inset
) to be used for line breaks.
The initial backslash must not be specified.
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
-, while keeping backward compatibility.
-\change_inserted -712698321 1559491850
-
+,
+ while keeping backward compatibility.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1559492002
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1559491854
ParbreakIgnored
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1559491850
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1559491850
1
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1559491881
1
-\change_unchanged
-
\end_layout
\end_inset
-, paragraph breaks will be ignored in the output.
- This might be useful for insets where the content should be alignable on
- different lines only in the \SpecialChar LyX
- workarea, without any effect in the output.
-\change_unchanged
-
+,
+ paragraph breaks will be ignored in the output.
+ This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
+ workarea,
+ without any effect in the output.
\end_layout
\begin_layout Description
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\end_inset
- As with paragraph styles, see
+ As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
+,
+ but you do not want to inherit its (required and optional) arguments.
\end_layout
\begin_layout Description
\end_inset
-]
-\change_inserted -712698321 1597733473
-If
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1597732178
1
-\change_unchanged
-
\end_layout
\end_inset
-, font changes are redone inside the respective inset (in the output) even
- if the inset itself is in the context of this font changes (e.
+,
+ font changes are redone inside the respective inset (in the output) even if the inset itself is in the context of this font changes (e.
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1597733683
-
\backslash
textbf{Sourrounding text
\backslash
\backslash
textbf{content}}\SpecialChar ldots
}
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1597733686
-
\backslash
textbf{Sourrounding text
\backslash
myinset{content}\SpecialChar ldots
}
-\change_unchanged
-
\end_layout
\end_inset
.
- Setting this makes sense for commands that internally reset font settings
- (e.
+ Setting this makes sense for commands that internally reset font settings (e.
\begin_inset space \thinspace{}
\end_inset
-g., footnotes).
+g.,
+ footnotes).
Note that wrongly setting this might lead to unwanted result (e.
\begin_inset space \thinspace{}
\end_inset
-g., with
+g.,
+ with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1597733688
-
\backslash
emph{Sourrounding text
\backslash
\backslash
emph{content}}\SpecialChar ldots
}
-\change_unchanged
-
\end_layout
\end_inset
-, content is upright, as
+,
+ content is upright,
+ as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1597733278
-
\backslash
emph
-\change_unchanged
-
\end_layout
\end_inset
toggles.
-
-\change_deleted -712698321 1597733283
-Whether this inset should use the font of its surrounding environment or
- uses its own.
-
-\change_unchanged
-Default is
-\change_deleted -712698321 1597733290
-false
-\change_inserted -712698321 1597733290
-
+ Default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1597733292
0
-\change_unchanged
-
\end_layout
\end_inset
-
-\change_unchanged
-:
-\change_deleted -712698321 1597733327
-use the font of the surrounding environment
-\change_inserted -712698321 1597733343
-font changes are not redone inside the inset
-\change_unchanged
-.
+:
+ font changes are not redone inside the inset.
\end_layout
\begin_layout Description
] Allow spell-checking the contents of this inset.
Default is true.
-\change_inserted -584632292 1615846659
-
\end_layout
\begin_layout Subsection
-
-\change_inserted -584632292 1615846729
Arguments
\begin_inset CommandInset label
LatexCommand label
\end_layout
\begin_layout Standard
-
-\change_inserted -584632292 1615846807
Both paragraph styles and inset layouts allow for
\emph on
arguments
\emph default
as well as the main content.
- This is especially useful for things like section headings and only makes
- sense with \SpecialChar LaTeX
+ This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
.
- Each (optional or required) argument of a command or environment—except
- for the required argument that is associated with the content—has a separate
- definition, where the number specifies the order of the arguments.
+ Each (optional or required) argument of a command or environment—
+except for the required argument that is associated with the content—
+has a separate definition,
+ where the number specifies the order of the arguments.
The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
EndArgument
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
Argument 1
\end_layout
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
...
\end_layout
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
EndArgument
\end_layout
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
Argument 2
\end_layout
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
...
\end_layout
\begin_layout Quote
-\change_inserted -584632292 1615846730
-
\family typewriter
EndArgument
\end_layout
\begin_layout Standard
-
-\change_inserted -584632292 1615846730
Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Argument
-\change_unchanged
-
\end_layout
\end_inset
- definition, the following specifications are possible:
+ definition,
+ the following specifications are possible:
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
LabelString
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
- The string that will appear both in the menu (to insert this argument)
- and on the argument inset button (unless you also specify a separate
+ The string that will appear both in the menu (to insert this argument) and on the argument inset button (unless you also specify a separate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
MenuString
-\change_unchanged
-
\end_layout
\end_inset
).
- For the menu, you can define an accelerator by appending the respective
- character to the string, divided by
+ For the menu,
+ you can define an accelerator by appending the respective character to the string,
+ divided by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Short Title|S
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
MenuString
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
A separate string for the menu.
- You can define an accelerator by appending the respective character to
- the string, divided by
+ You can define an accelerator by appending the respective character to the string,
+ divided by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Short Title|S
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
LabelString
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Tooltip
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
- A longer explanatory text that appears in the tooltip when hovering over
- the argument inset.
+ A longer explanatory text that appears in the tooltip when hovering over the argument inset.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Mandatory
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
] Declare if this is a mandatory (1) or an optional (0) argument.
- Mandatory arguments will be output empty if not given, while optional arguments
- will not be output at all.
- By default, mandatory arguments are delimited by
+ Mandatory arguments will be output empty if not given,
+ while optional arguments will not be output at all.
+ By default,
+ mandatory arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
{...}
-\change_unchanged
-
\end_layout
\end_inset
-, while optional arguments are delimited by
+,
+ while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[...]
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
NewlineCmd
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\backslash
\backslash
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Requires
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[int=0]
-\change_unchanged
-
\end_layout
\end_inset
- defines another argument (by its number) which this argument requires to
- be output if it is itself output.
+ defines another argument or arguments (by their number) which this argument requires to be output if it is itself output.
E.
\begin_inset space \thinspace{}
\end_inset
-g., in \SpecialChar LaTeX
- commands, optional arguments often require previous optional arguments
- to be output (at least empty), as in
+g.,
+ in \SpecialChar LaTeX
+ commands,
+ optional arguments often require previous optional arguments to be output (at least empty),
+ as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\backslash
command[][argument]{text}
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Requires 1
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Argument 2
-\change_unchanged
-
\end_layout
\end_inset
.
+ If multiple arguments are required,
+ separate them by comma (e.g.,
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires 1,2
\end_layout
-\begin_layout Itemize
+\end_inset
+
+).
+\end_layout
-\change_inserted -584632292 1615846730
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
LeftDelim
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
{
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
<br/>
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
RightDelim
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
}
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
<br/>
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
DefaultArg
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
- defines an argument that is inserted if and only if no user-specified arguments
- were given, i.
+ defines an argument that is inserted if and only if no user-specified arguments were given,
+ i.
\begin_inset space \thinspace{}
\end_inset
\begin_inset space \space{}
\end_inset
-if no argument inset has been inserted (note that also an empty argument
- inset omits the DefaultArg).
+if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
Multiple arguments need to be separated by comma.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
PresetArg
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[string]
-\change_unchanged
-
\end_layout
\end_inset
- defines an argument that is inserted in any case (alone or in addition
- to user-specified arguments).
+ defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
Multiple arguments need to be separated by comma.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Font
-\change_unchanged
-
\end_layout
\end_inset
- The font used for the argument content, see
+ The font used for the argument content,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
FreeSpacing
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
-] As with paragraph styles, see
+] As with paragraph styles,
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Paragraph-Styles"
+nolink "false"
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
LabelFont
-\change_unchanged
-
\end_layout
\end_inset
- The font used for the label; see
+ The font used for the label;
+ see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Decoration
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\emph on
Classic
\emph default
-, Minimalistic, Conglomerate
-\change_unchanged
-
+,
+ Minimalistic,
+ Conglomerate
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
AutoInsert
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[int=0]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
-, this argument is automatically inserted when the respective style is selected.
+,
+ this argument is automatically inserted when the respective style is selected.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
InsertOnNewline
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[int=0]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
-, this argument will be inserted on a new line with
+,
+ this argument will be inserted on a new line with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
AutoInsert
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
InsertCotext
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
[int=0]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
-, this argument will be inserted with a copy of the co-text (either selected
- text or the whole paragraph) as content.
+,
+ this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
PassThru
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\emph on
inherited
\emph default
-, true, false
-\change_unchanged
-
+,
+ true,
+ false
\end_layout
\end_inset
-] Whether the contents of this argument should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
+] Whether the contents of this argument should be output in raw form,
+ meaning without special translations that \SpecialChar LaTeX
would require.
- By default, the
+ By default,
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
PassThru
-\change_unchanged
-
\end_layout
\end_inset
- status is inherited by the inset or paragraph layout the argument belongs
- to, true and false change the status for the given argument only.
+ status is inherited by the inset or paragraph layout the argument belongs to,
+ true and false change the status for the given argument only.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
PassThruChars
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
string of characters
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Newline linebreak
\end_inset
-that should be output in raw form, meaning without special translations
- that \SpecialChar LaTeX
+that should be output in raw form,
+ meaning without special translations that \SpecialChar LaTeX
would require.
- Note that, contrary to PassThru, this needs to be explicitly defined for
- arguments.
- That is, arguments do not inherit PassThruChars from their parent inset
- or layout.
+ Note that,
+ contrary to PassThru,
+ this needs to be explicitly defined for arguments.
+ That is,
+ arguments do not inherit PassThruChars from their parent inset or layout.
\end_layout
\begin_layout Itemize
-
-\change_inserted -584632292 1615846730
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
IsTocCaption
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\emph on
0
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
1
-\change_unchanged
-
\end_layout
\end_inset
-] If this is set to 1, the argument will output its content in the corresponding
- item in the table of contents.
+] If this is set to 1,
+ the argument will output its content in the corresponding item in the table of contents.
See AddToToc.
\end_layout
\begin_layout Standard
-
-\change_inserted -584632292 1615846730
-By default, the text entered in the \SpecialChar LyX
- workarea in the respective layout is
- the last (mandatory) argument of a command if the
+By default,
+ the text entered in the \SpecialChar LyX
+ workarea in the respective layout is the last (mandatory) argument of a command if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
LatexType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Command
-\change_unchanged
-
\end_layout
\end_inset
.
- However, arguments with the prefix
+ However,
+ arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
post:
-\change_unchanged
-
\end_layout
\end_inset
are output after this workarea argument.
- Note that post-argument numbering restarts at 1, so the first argument
- following the workarea argument is
+ Note that post-argument numbering restarts at 1,
+ so the first argument following the workarea argument is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
post:1
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
-LatexType
-\change_unchanged
-
+\begin_layout Plain Layout
+LatexType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Command
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_inserted -584632292 1615846730
Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\backslash
item
-\change_unchanged
-
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\backslash
item[foo]
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
item:
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Argument item:1
-\change_unchanged
-
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-
-\change_inserted -584632292 1615846730
-Finally, there is a special argument type with the prefix
+Finally,
+ there is a special argument type with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
listpreamble:
-\change_unchanged
-
\end_layout
\end_inset
.
- It is not really an argument, but uses the argument interface (thus, the
- prefix is also followed by a number, e.
+ It is not really an argument,
+ but uses the argument interface (thus,
+ the prefix is also followed by a number,
+ e.
\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -584632292 1615846730
Argument listpreamble:1
-\change_unchanged
-
\end_layout
\end_inset
).
- As the name implies, it is targeted at lists such as
+ As the name implies,
+ it is targeted at lists such as
\family sans
Itemize
\family default
-,
+,
+
\family sans
Enumerate
\family default
-,
+,
+
\family sans
Description
\family default
-, or
+,
+ or
\family sans
Bibliography
\family default
.
- Its content will be output at the list start, before the first
+ Its content will be output at the list start,
+ before the first
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -584632292 1615846730
-
\backslash
item
-\change_unchanged
-
\end_layout
\end_inset
-, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+,
+ on an own line (a place that is otherwise not accessible in \SpecialChar LyX
).
- This way, users can insert redefinitions (of lengths etc.) to individual
- lists.
- By default, these arguments do not have a delimiter.
-\change_unchanged
-
+ This way,
+ users can insert redefinitions (of lengths etc.) to individual lists.
+ By default,
+ these arguments do not have a delimiter.
\end_layout
\begin_layout Subsection
\end_inset
-,
+,
+
\begin_inset Flex Noun
status collapsed
\end_inset
-, \SpecialChar ldots
+,
+ \SpecialChar ldots
) in the text class itself.
The standard counters are defined in the file
\begin_inset Flex Code
\end_inset
-, so you may have to do no more than add
+,
+ so you may have to do no more than add
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
+ But if you want to define custom counters,
+ then you can do so.
The counter declaration must begin with:
\end_layout
\end_inset
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
+] Sets the initial value for the counter,
+ to which it will be reset whenever that happens.
+ Normally,
+ one will want the default,
+ 1.
\end_layout
\begin_layout Description
\begin_inset Quotes erd
\end_inset
-] When defined, this string defines how the counter is displayed.
+] When defined,
+ this string defines how the counter is displayed.
Setting this value sets
\begin_inset Flex Code
status collapsed
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\bar no
\noun off
\color none
-Actually, the situation is a bit more complicated: any
+Actually,
+ the situation is a bit more complicated:
+ any
\family default
\series default
\shape default
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
+:
+ 1,
+ 2,
+ 3,\SpecialChar ldots
+;
+
\begin_inset Flex Code
status collapsed
\end_inset
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
+ for lower-case letters:
+ a,
+ b,
+ c,
+ \SpecialChar ldots
+;
+
\begin_inset Flex Code
status collapsed
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
+ for upper-case letters:
+ A,
+ B,
+ C,
+ \SpecialChar ldots
+;
+
\begin_inset Flex Code
status collapsed
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
-;
+ for lower-case roman numerals:
+ i,
+ ii,
+ iii,
+ \SpecialChar ldots
+;
+
\begin_inset Flex Code
status collapsed
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
+ for upper-case roman numerals:
+ I,
+ II,
+ III\SpecialChar ldots
+;
+
\begin_inset Flex Code
status collapsed
\end_deeper
\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a
-\change_deleted 731793113 1604355218
-master
-\change_inserted 731793113 1604355221
-parent
-\change_unchanged
- counter
+If LabelString is not defined,
+ a default value is constructed as follows:
+ if the counter has a parent counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted 731793113 1604355223
-master
-\change_inserted 731793113 1604355226
parent
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
-), the string
+),
+ the string
\begin_inset Newline newline
\end_inset
\begin_layout Plain Layout
\backslash
-the
-\change_inserted 731793113 1604355228
-parent
-\change_deleted 731793113 1604355230
-master
-\change_unchanged
-.
+theparent.
\backslash
arabic{counter}
\end_layout
\end_inset
- is used; otherwise the string
+ is used;
+ otherwise the string
\begin_inset Flex Code
status collapsed
\end_inset
-, but for use in the Appendix.
-\change_inserted -584632292 1607202551
-
+,
+ but for use in the Appendix.
\end_layout
\begin_layout Description
-
-\change_inserted -584632292 1607202682
\begin_inset Flex Code
status open
status open
\begin_layout Plain Layout
-
-\change_inserted -584632292 1607202576
string
-\change_unchanged
-
\end_layout
\end_inset
] The counter name as used in \SpecialChar LaTeX
.
- (
-\change_inserted 34634807 1619711355
-e
-\change_deleted 34634807 1619711355
-E
-\change_inserted -584632292 1607202682
-.g., in \SpecialChar LyX
-, there is a counter named `theorem', but it is output to \SpecialChar LaTeX
+ (e.g.,
+ in \SpecialChar LyX
+,
+ there is a counter named `theorem',
+ but it is output to \SpecialChar LaTeX
as `thm'.)
-\change_unchanged
-
\end_layout
\begin_layout Description
\end_inset
] A format for use with formatted references to this counter.
- For example, one might want to have references to section numbers appear
- as
+ For example,
+ one might want to have references to section numbers appear as
\begin_inset Quotes eld
\end_inset
\end_inset
.
- The string should contain
+ The string may contain
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Within
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
+ or a counter specification as in
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-subsection
+LabelString
\end_layout
\end_inset
- is numbered inside
+.
+ The former will be replaced by the counter number itself.
+ So,
+ for sections,
+ it would be:
+ Section ##,
+ or perhaps:
+
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-section
-\end_layout
-\end_inset
-
-.
+\backslash
+S
+\backslash
+arabic{section}
\end_layout
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Font-description"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-A font description looks like this:
-\end_layout
-
-\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
-\emph on
-
-\family roman
-or
-\family default
-\emph default
- DefaultFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
-\end_layout
-
-\begin_layout Standard
-The following commands are available:
+ (which might render as §2.7).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Color
+RefFormat
\end_layout
\end_inset
[
-\change_deleted -712698321 1607682984
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-none
+string
\end_layout
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+string
\end_layout
\end_inset
-,
+] For use with `formatted references',
+ specifically when a single counter is used with multiple sorts of styles.
+ For example,
+ the
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-white
+theorem
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-red
-\end_layout
-
+ counter is often used for all sorts of theorem-like environments:
+ Theorem,
+ Lemma,
+ etc.
+ The first argument gives a prefix used in the labels (e.g.,
+
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-green
-\end_layout
-
+thm
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-blue
-\end_layout
-
+ or
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-cyan
-\end_layout
-
+lem
+\begin_inset Quotes erd
\end_inset
-,
+),
+ and the second a formatting string,
+ as for
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-magenta
+LabelString
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-yellow
+PrettyFormat
\end_layout
\end_inset
-,
+.
+ If this is not given,
+ then
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-brown
+PrettyFormat
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-darkgray
+ is used.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-gray
+Within
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lightgray
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-lime
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] If this is set to the name of another counter,
+ the present counter will be reset every time the other one is increased.
+ For example,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-orange
+subsection
\end_layout
\end_inset
-,
+ is numbered inside
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-olive
+section
\end_layout
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-pink
+.
\end_layout
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Font-description"
+
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-purple
\end_layout
-\end_inset
+\begin_layout Standard
+A font description looks like this:
+\end_layout
-,
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\emph on
+
+\family roman
+or
+\family default
+\emph default
+ DefaultFont
+\end_layout
-\begin_layout Plain Layout
-teal
+\begin_layout LyX-Code
+ ...
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndFont
+\end_layout
+
+\begin_layout Standard
+The following commands are available:
+\end_layout
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-violet
+Color
\end_layout
\end_inset
-
-\change_inserted -712698321 1607683139
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1607683135
string
-\change_unchanged
-
\end_layout
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
- for
-\change_deleted -712698321 1607683144
-]
-\change_inserted -712698321 1607683146
-valid arguments.
-\change_unchanged
-
+ for valid arguments.
\end_layout
\begin_layout Description
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-] Valid arguments are:
+] Valid arguments are:
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
.
Each of these turns on or off the corresponding attribute.
- For example,
+ For example,
+
\begin_inset Flex Code
status collapsed
\end_inset
- turns on emphasis, and
+ turns on emphasis,
+ and
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-If the latter seems puzzling, remember that the font settings for the present
- context are generally inherited from the surrounding context.
+If the latter seems puzzling,
+ remember that the font settings for the present context are generally inherited from the surrounding context.
So
\begin_inset Flex Code
status collapsed
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+ would turn off the emphasis that was anyway in effect,
+ say,
+ in a theorem environment.
\end_layout
\begin_layout Description
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
- blocks, as used mainly in cite engine files (see
+ blocks,
+ as used mainly in cite engine files (see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Cite-Engine-Files"
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
-), define the citation commands provided by a specific
+),
+ define the citation commands provided by a specific
\begin_inset Quotes eld
\end_inset
\end_inset
.
- A cite engine, in \SpecialChar LyX
- terms, is way specific way to format citations, using
- numbers, author names and/or years.
- Currently, \SpecialChar LyX
- supports three such engine types, namely:
+ A cite engine,
+ in \SpecialChar LyX
+ terms,
+ is way specific way to format citations,
+ using numbers,
+ author names and/or years.
+ Currently,
+ \SpecialChar LyX
+ supports three such engine types,
+ namely:
\end_layout
\begin_layout Enumerate
\end_inset
-: the default Bib\SpecialChar TeX
- way to format citations, a simple numeric style (e.
+:
+ the default Bib\SpecialChar TeX
+ way to format citations,
+ a simple numeric style (e.
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.,
+
\begin_inset Quotes eld
\end_inset
\end_inset
-: Harvard-styled citations using author names and publication year (e.
+:
+ Harvard-styled citations using author names and publication year (e.
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.,
+
\begin_inset Quotes eld
\end_inset
\end_inset
-: extended numerical citations that also allow for author or title next
- to the number (e.
+:
+ extended numerical citations that also allow for author or title next to the number (e.
\begin_inset space \thinspace{}
\end_inset
-g.,
+g.,
+
\begin_inset Quotes eld
\end_inset
\end_inset
denotes the engine.
- The individual lines respectively define a cite command or cite command
- paradigm supported by this engine.
- The line can be as simple as a cite command that is used both to name the
- respective \SpecialChar LyX
+ The individual lines respectively define a cite command or cite command paradigm supported by this engine.
+ The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
command and the \SpecialChar LaTeX
- output or more complex in order to differentiate
- things.
+ output or more complex in order to differentiate things.
The full syntax is:
\end_layout
\end_inset
-: The name as used in the
+:
+ The name as used in the
\begin_inset Flex Code
status collapsed
\begin_deeper
\begin_layout Standard
-For portability reasons, we try to use the same name for same-formatted
- commands in different cite packages (thus many names stem from natbib,
+For portability reasons,
+ we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
and thus we need to differentiate a
\begin_inset Flex Code
status collapsed
\end_inset
- sometimes, if the \SpecialChar LaTeX
+ sometimes,
+ if the \SpecialChar LaTeX
command names differ).
\end_layout
\end_inset
-: a (comma-separated) list of commands that fall back to the given
+:
+ a (comma-separated) list of commands that fall back to the given
\begin_inset Flex Code
status collapsed
\end_inset
-: The actual \SpecialChar LaTeX
+:
+ The actual \SpecialChar LaTeX
command that is output.
\end_layout
\end_inset
- is given, the
+ is given,
+ the
\begin_inset Flex Code
status collapsed
\begin_deeper
\begin_layout Standard
-By default, the starred version means: Output all authors even if it should
- be shortened with
+By default,
+ the starred version means:
+ Output all authors even if it should be shortened with
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-If the star has a different meaning for a given command, it can be specified
- in angle brackets:
+If the star has a different meaning for a given command,
+ it can be specified in angle brackets:
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- Maximal two translatable macro keywords, marked by the prefix
+ Maximal two translatable macro keywords,
+ marked by the prefix
\begin_inset Flex Code
status collapsed
\end_inset
-, can be given.
+,
+ can be given.
The first points to the string that replaces the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- checkbox label in the citation dialog, the second one to an optional tool
- tip for this checkbox.
+ checkbox label in the citation dialog,
+ the second one to an optional tool tip for this checkbox.
\end_layout
\end_inset
- (see next section), dropping the
+ (see next section),
+ dropping the
\begin_inset Flex Code
status collapsed
\end_inset
- from the prefix, like this:
+ from the prefix,
+ like this:
+
\end_layout
\begin_layout LyX-Code
\family sans
Biblatex
\family default
--specific feature for multi-reference citations where an individual pre-
- and postnote can be given to each reference in the list.
+-specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
Please refer to the
\family sans
Biblatex
\family default
manual for details.
-\change_inserted -712698321 1526898670
-
\end_layout
\begin_layout Standard
-
-\change_inserted -712698321 1526899524
If you want to add a cite command to a cite engine (e.
\begin_inset space \thinspace{}
\end_inset
-g., add a specific command provided by a class), you can use
+g.,
+ add a specific command provided by a class),
+ you can use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1526898768
AddToCiteEngine <engine type> \SpecialChar ldots
End
-\change_unchanged
-
\end_layout
\end_inset
.
Note that only cite commands that do not exist yet are added.
-\change_unchanged
-
\end_layout
\begin_layout Subsection
blocks are used to describe how bibliographic information should be displayed,
both within \SpecialChar LyX
- itself (in the citation dialog and in tooltips, for example)
- and in XHTML output.
+ itself (in the citation dialog and in tooltips,
+ for example) and in XHTML output.
Such a block might look like this:
\end_layout
\end_layout
\begin_layout Standard
-In the first case, the individual lines define how the bibliographic information
- associated with an article or book, respectively, is to be displayed, and
- such a definition can be given for any
+In the first case,
+ the individual lines define how the bibliographic information associated with an article or book,
+ respectively,
+ is to be displayed,
+ and such a definition can be given for any
\begin_inset Quotes els
\end_inset
that might be present in a Bib\SpecialChar TeX
file.
\SpecialChar LyX
- defines a default format in the source code that will be used if no specific
- definition has been given.
+ defines a default format in the source code that will be used if no specific definition has been given.
\SpecialChar LyX
predefines several formats in the file
\begin_inset Flex Code
\end_inset
-, which is included in most of \SpecialChar LyX
+,
+ which is included in most of \SpecialChar LyX
's document classes.
\end_layout
\begin_layout Standard
-In the second case, the lines define how a specific citation command (in
- the example
+In the second case,
+ the lines define how a specific citation command (in the example
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-) is to be displayed on the citation inset label, in the citation dialog,
+) is to be displayed on the citation inset label,
+ in the citation dialog,
menu or XHTML output.
\SpecialChar LyX
defines such formats for the citation style variants it supports via
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
\begin_layout Standard
The definitions use a simple language that allows Bib\SpecialChar TeX
- keys to be replaced
- with their values.
+ keys to be replaced with their values.
Keys should be enclosed in
\begin_inset Flex Code
status collapsed
\end_inset
- signs, e.g.:
+ signs,
+ e.g.:
+
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout LyX-Code
-misc %author%,
+misc %author%,
+
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-This would print the author, followed by a comma, followed by the title,
- in quotes, followed by a period.
+This would print the author,
+ followed by a comma,
+ followed by the title,
+ in quotes,
+ followed by a period.
\end_layout
\begin_layout Standard
-Of course, sometimes you may want to print a key only if it exists.
- This can be done by using a conditional construction, such as:
+Of course,
+ sometimes you may want to print a key only if it exists.
+ This can be done by using a conditional construction,
+ such as:
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- This says: If the
+ This says:
+ If the
\begin_inset Flex Code
status collapsed
\end_inset
- key exists, then print
+ key exists,
+ then print
\begin_inset Quotes eld
\end_inset
\end_inset
followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
+ It is also possible to have an else clause in the conditional,
+ such as:
\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+{%author%[[%author%]][[%editor%,
+ ed.]]}
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-Here, the
+Here,
+ the
\begin_inset Flex Code
status collapsed
\end_inset
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
+ key is printed if it exists;
+ otherwise,
+ the editor key is printed,
+ followed by
\begin_inset Quotes eld
\end_inset
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
+ signs;
+ the entire conditional is enclosed in braces;
+ and the if and else clauses are enclosed in double brackets,
+
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Next to the entry keys, there are some special keys that can be used for
- these conditionals:
+Next to the entry keys,
+ there are some special keys that can be used for these conditionals:
\end_layout
\begin_layout Itemize
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- part for dialogs and menus, the
+ part for dialogs and menus,
+ the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- part for other contexts (workarea, export)
+ part for other contexts (workarea,
+ export)
\end_layout
\begin_layout Itemize
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- part for export and menus, the
+ part for export and menus,
+ the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- part for other contexts (workarea, dialog)
+ part for other contexts (workarea,
+ dialog)
\end_layout
\begin_layout Itemize
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g., in a citation with multiple keys)
+g.,
+ in a citation with multiple keys)
\end_layout
\begin_layout Itemize
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- if this is the second of multiple items, else the
+ if this is the second of multiple items,
+ else the
\begin_inset Quotes eld
\end_inset
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\end_inset
-), the false part for unstarred
+),
+ the false part for unstarred
\end_layout
\begin_layout Itemize
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\end_inset
-, else the false part (e.g., in a citation definition:
+,
+ else the false part (e.g.,
+ in a citation definition:
+
\begin_inset Flex Code
status collapsed
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- if the current author type (author, editor etc.) has multiple authors, else
- the false part (e.g., in a bibliography definition:
+ if the current author type (author,
+ editor etc.) has multiple authors,
+ else the false part (e.g.,
+ in a bibliography definition:
+
\begin_inset Flex Code
status collapsed
\end_inset
-: process the
+:
+ process the
\begin_inset Quotes eld
\end_inset
\family sans
Biblatex
\family default
- format for multi-reference citations), the false part if this is not the
- case.
+ format for multi-reference citations),
+ the false part if this is not the case.
\end_layout
\begin_layout Standard
\end_inset
prints the author key as it is recorded in the bibliography file.
- This might not be what you want, since it will result in a string such
- as
+ This might not be what you want,
+ since it will result in a string such as
\begin_inset Quotes eld
\end_inset
-Miller, Peter and Smith, Mary and White, Jane
+Miller,
+ Peter and Smith,
+ Mary and White,
+ Jane
\begin_inset Quotes erd
\end_inset
is used by Bib\SpecialChar TeX
to delimit authors).
\SpecialChar LyX
- therefore provides some methods to get properly formatted name lists (which
- will also get translated).
+ therefore provides some methods to get properly formatted name lists (which will also get translated).
The following keys are provided:
\end_layout
\begin_layout Enumerate
-For name lists with pre- and surname, suitable for the main authors/editors
- of a bibliography item.
+For name lists with pre- and surname,
+ suitable for the main authors/editors of a bibliography item.
The
\begin_inset Flex Code
status collapsed
\end_inset
-: Provides a name list which is abbreviated (with
+:
+ Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a full name list (never abbreviated with
+:
+ Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a name list which is always abbreviated (with
+:
+ Provides a name list which is always abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_deeper
\begin_layout Enumerate
-Alternative name lists with pre- and surname, if the order of pre- and surname
- inside the bibliography item differs (as in:
+Alternative name lists with pre- and surname,
+ if the order of pre- and surname inside the bibliography item differs (as in:
+
\begin_inset Quotes eld
\end_inset
-Miller, John: Some text, in: Mary Smith, ed.: A volume
+Miller,
+ John:
+ Some text,
+ in:
+ Mary Smith,
+ ed.:
+ A volume
\begin_inset Quotes erd
\end_inset
\end_inset
-: Provides a name list which is abbreviated (with
+:
+ Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a full name list (never abbreviated with
+:
+ Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a name list which is always abbreviated (with
+:
+ Provides a name list which is always abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_deeper
\begin_layout Enumerate
-And finally name lists which consist of family names only, as used in author-yea
-r citation labels.
+And finally name lists which consist of family names only,
+ as used in author-year citation labels.
These do not take a
\begin_inset Flex Code
status collapsed
\end_inset
- part, but always return either an author list or, if this does not exist,
+ part,
+ but always return either an author list or,
+ if this does not exist,
an editor list (as common in author-year labels):
\end_layout
\end_inset
-: Provides a name list which is abbreviated (with
+:
+ Provides a name list which is abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a full name list (never abbreviated with
+:
+ Provides a full name list (never abbreviated with
\begin_inset Quotes eld
\end_inset
\end_inset
-: Provides a name list which is always abbreviated (with
+:
+ Provides a name list which is always abbreviated (with
\begin_inset Quotes eld
\end_inset
\end_deeper
\begin_layout Standard
-The order of pre- and surname in the former two lists can be adjusted by
- these macros:
+The order of pre- and surname in the former two lists can be adjusted by these macros:
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-!firstnameform %surname%, %prename%
+!firstnameform %surname%,
+ %prename%
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-!othernameform %surname%, %prename%
+!othernameform %surname%,
+ %prename%
\end_layout
\end_inset
\begin_inset Quotes eld
\end_inset
-Miller, Peter and Mary Smith: \SpecialChar ldots
-, in: John Doe and Pat Green, eds.:\SpecialChar ldots
+Miller,
+ Peter and Mary Smith:
+ \SpecialChar ldots
+,
+ in:
+ John Doe and Pat Green,
+ eds.:\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
-There is one other piece of syntax available in definitions, which looks
- like this:
+There is one other piece of syntax available in definitions,
+ which looks like this:
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- This defines a piece of formatting information that is to be used when
- creating
+ This defines a piece of formatting information that is to be used when creating
\begin_inset Quotes eld
\end_inset
\end_inset
.
- Obviously, we do not want to output HTML tags when writing plain text,
+ Obviously,
+ we do not want to output HTML tags when writing plain text,
so they should be wrapped in
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-This is an abbreviation, or macro, and it can be used by treating it as
- if it were a key:
+This is an abbreviation,
+ or macro,
+ and it can be used by treating it as if it were a key:
+
\begin_inset Flex Code
status collapsed
\end_inset
exactly as it would treat its definition.
- So, let us issue the obvious
+ So,
+ let us issue the obvious
\emph on
warning
\emph default
\begin_layout Standard
or anything like it.
\SpecialChar LyX
- shouldn't go into an infinite loop, but it may go into a long one before
- it gives up.
+ shouldn't go into an infinite loop,
+ but it may go into a long one before it gives up.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-This defines a translatable piece of text, which allows relevant parts of
- the bibliography or citation to be translated.
- It can be included in a definition by treating it as a key:
+This defines a translatable piece of text,
+ which allows relevant parts of the bibliography or citation to be translated.
+ It can be included in a definition by treating it as a key:
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- Note that there are two different translation paths: All definitions starting
- with
+ Note that there are two different translation paths:
+ All definitions starting with
\begin_inset Flex Code
status collapsed
\end_inset
-, such as in the example above, will be translated to the currently active
- buffer language (so the translation will match the generated document).
- All definitions starting with underscore only will be translated to the
- GUI language.
- This is the proper translation for strings that only occur in the dialogs
- or on buttons, such as this one:
+,
+ such as in the example above,
+ will be translated to the currently active buffer language (so the translation will match the generated document).
+ All definitions starting with underscore only will be translated to the GUI language.
+ This is the proper translation for strings that only occur in the dialogs or on buttons,
+ such as this one:
\end_layout
\begin_layout LyX-Code
\end_inset
files.
- Note that these are not macros, in the sense just defined.
+ Note that these are not macros,
+ in the sense just defined.
They will not be expanded.
\end_layout
\noindent
\family sans
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
+!authoredit {%author%[[%author%,
+ ]][[{%editor%[[%editor%,
+ %B_edtext%,
+ ]]}]]}
\end_layout
\begin_layout Standard
\begin_inset VSpace defskip
\end_inset
-This defines a macro that prints the author, followed by a comma, if the
-
+This defines a macro that prints the author,
+ followed by a comma,
+ if the
\begin_inset Flex Code
status collapsed
\end_inset
- key is defined, or else prints the name of the editor, followed by the
-
+ key is defined,
+ or else prints the name of the editor,
+ followed by the
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-), if the
+),
+ if the
\begin_inset Flex Code
status collapsed
\end_inset
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
+,
+ so you can use it in your own definitions,
+ or re-definitions,
+ if you load that file first.
\end_layout
\begin_layout Section
\begin_layout Standard
As with \SpecialChar LaTeX
- or DocBook, the format of \SpecialChar LyX
-'s XHTML output is also controlled by
- layout information.
- In general, \SpecialChar LyX
- provides sensible defaults and, as mentioned earlier, it will
- even construct default CSS style rules from the other layout tags.
- For example, \SpecialChar LyX
+ or DocBook,
+ the format of \SpecialChar LyX
+'s XHTML output is also controlled by layout information.
+ In general,
+ \SpecialChar LyX
+ provides sensible defaults and,
+ as mentioned earlier,
+ it will even construct default CSS style rules from the other layout tags.
+ For example,
+ \SpecialChar LyX
will attempt to use the information provided in the
\begin_inset Flex Code
status collapsed
\end_inset
- declaration for the Chapter style to write CSS that will appropriately
- format chapter headings.
+ declaration for the Chapter style to write CSS that will appropriately format chapter headings.
\end_layout
\begin_layout Standard
-In many cases, then, you may not have to do anything at all to get acceptable
- XHTML output for your own environments, custom insets, and so forth.
- But in some cases you will, and so \SpecialChar LyX
- provides a number of layout tags that
- can be used to customize the XHTML and CSS that are generated.
+In many cases,
+ then,
+ you may not have to do anything at all to get acceptable XHTML output for your own environments,
+ custom insets,
+ and so forth.
+ But in some cases you will,
+ and so \SpecialChar LyX
+ provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
\end_layout
\begin_layout Standard
-Note that there are two tags,
+Note that there are two tags,
+
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:General-text-class"
+nolink "false"
\end_inset
\begin_layout Standard
The sort of XHTML \SpecialChar LyX
- outputs for a paragraph depends upon whether we are dealing
- with a normal paragraph, a command, or an environment, where this is itself
- determined by the contents of the corresponding
+ outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
+ a command,
+ or an environment,
+ where this is itself determined by the contents of the corresponding
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
+For a command or normal paragraph,
+ the output XHTML has the following form:
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+For an environment that is not some sort of list,
+ the XHTML takes this form:
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-Note that the label is output only for the first paragraph, as it should
- be for a theorem, for example.
+Note that the label is output only for the first paragraph,
+ as it should be for a theorem,
+ for example.
\end_layout
\begin_layout Standard
-For a list, we have one of these forms:
+For a list,
+ we have one of these forms:
\end_layout
\begin_layout LyX-Code
\end_inset
-: If
+:
+ If
\begin_inset Flex Code
status collapsed
\end_inset
- is false (the default), you get the first of these, with the label within
- the item; if true, you get the second, with the label outside the item.
+ is false (the default),
+ you get the first of these,
+ with the label within the item;
+ if true,
+ you get the second,
+ with the label outside the item.
\end_layout
\begin_layout Standard
-The specific tags and attributes output for each paragraph type can be controlle
-d by means of the layout tags we are about to describe.
- As mentioned earlier, however, \SpecialChar LyX
+The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
+ As mentioned earlier,
+ however,
+ \SpecialChar LyX
uses sensible defaults for many of these,
so you often may not need to do very much to get good XHTML output.
Think of the available tags as there so you can tweak things to your liking.
\end_inset
] Specifies attribute information to be output with the main tag.
- For example,
+ For example,
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`mydiv'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default,
+ \SpecialChar LyX
+ will output
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`mydiv'
+class=`layoutname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+ where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+layoutname
+\end_layout
+
+\end_inset
+
+ is the \SpecialChar LyX
+ name of the layout,
+ made lowercase,
+ for example:
+ chapter.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLClass
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+] The CSS class to use for this paragraph.
+ Note that,
+ if the paragarph is of enumerate or itemize type,
+ then the default will be
+\begin_inset Quotes eld
+\end_inset
+lyxenum
\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
+ or
\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-class=`layoutname'
-\end_layout
-
+lyxitem
+\begin_inset Quotes erd
\end_inset
+,
+ plus
+\begin_inset Quotes eld
+\end_inset
+i
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
+,
+
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-layoutname
-\end_layout
+ii
+\begin_inset Quotes erd
+\end_inset
+,
+
+\begin_inset Quotes eld
\end_inset
- is the \SpecialChar LyX
- name of the layout, made lowercase, for example: chapter.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+iii
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-HTMLStyle
-\end_layout
+,
+ or
+\begin_inset Quotes eld
+\end_inset
+iv
+\begin_inset Quotes erd
\end_inset
- for that purpose.
+,
+ depending upon the depth.
+ That can be over-ridden here.
+ However,
+ the suffix will not be added in that case.
+ I.e.,
+ the CSS class will always be exactly what it is declared to be here.
\end_layout
\begin_layout Description
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
+ allows you to alter or augment the generated CSS,
+ rather than to override it completely.
Default is
\begin_inset Flex Code
status collapsed
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+HTMLInToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+0,
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether to include this paragraph (usually,
+ a section or something of the sort) in the TOC.
+ By default,
+ true,
+ so it should be set to false e.g.
+\begin_inset space ~
+\end_inset
+
+for starred sections.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
HTMLItem
\end_layout
\end_inset
-] The tag to be used for individual paragraphs of environments, replacing
-
+] The tag to be used for individual paragraphs of environments,
+ replacing
\begin_inset Flex Code
status collapsed
\end_inset
-] The tag to be used for paragraph and item labels, replacing
+] The tag to be used for paragraph and item labels,
+ replacing
\begin_inset Flex Code
status collapsed
\end_inset
-, unless
+,
+ unless
\begin_inset Flex Code
status collapsed
\end_inset
-, in which case it defaults to
+,
+ in which case it defaults to
\begin_inset Flex Code
status collapsed
\end_inset
-] Meaningful only for list-like environments, this tag controls whether
- the label tag is output before or inside the item tag.
- This is used, for example, in the description environment, where we want
- `
+] Meaningful only for list-like environments,
+ this tag controls whether the label tag is output before or inside the item tag.
+ This is used,
+ for example,
+ in the description environment,
+ where we want `
\begin_inset Flex Code
status collapsed
\end_inset
-: The label tag is output inside the item tag.
+:
+ The label tag is output inside the item tag.
\end_layout
\begin_layout Description
\end_inset
section when this style is used.
- This might, for example, be used to include a
+ This might,
+ for example,
+ be used to include a
\begin_inset Flex Code
status collapsed
\end_inset
- block, so only the CSS itself need be included.
+ block,
+ so only the CSS itself need be included.
Must end with
\begin_inset Flex Code
status collapsed
\end_inset
-] The tag to be used for the main label, replacing
+] The tag to be used for the main label,
+ replacing
\begin_inset Flex Code
status collapsed
\end_inset
tag for the XHTML file.
- By default, it is false.
+ By default,
+ it is false.
The
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The XHTML output of insets can also be controlled by information in layout
- files.
+The XHTML output of insets can also be controlled by information in layout files.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-At present, this is true only for
+At present,
+ this is true only for
\begin_inset Quotes eld
\end_inset
\end_inset
- Here, too, \SpecialChar LyX
- tries to provide sensible defaults, and it constructs default
- CSS style rules.
+ Here,
+ too,
+ \SpecialChar LyX
+ tries to provide sensible defaults,
+ and it constructs default CSS style rules.
But everything can be customized.
\end_layout
\end_layout
\begin_layout Standard
-If the inset permits multiple paragraphs—that is, if
+If the inset permits multiple paragraphs—
+that is,
+ if
\begin_inset Flex Code
status collapsed
\end_inset
- is true—then the contents of the inset will itself be output as paragraphs
- formatted according to the styles used for those paragraphs (standard,
- quote, and the like).
- The label tag is of course omitted if the paragraph does not have a label
- and, at present, is always
+ is true—
+then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
+ quote,
+ and the like).
+ The label tag is of course omitted if the paragraph does not have a label and,
+ at present,
+ is always
\begin_inset Flex Code
status collapsed
\end_inset
.
- The inner tag is optional and, by default, does not appear.
+ The inner tag is optional and,
+ by default,
+ does not appear.
\end_layout
\begin_layout Standard
-The specific tags and attributes output for each inset can be controlled
- by means of the following layout tags.
+The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
\end_layout
\begin_layout Description
\end_inset
] Specifies attribute information to be output with the main tag.
- For example,
+ For example,
+
\begin_inset Quotes eld
\end_inset
\end_inset
.
- By default, \SpecialChar LyX
+ By default,
+ \SpecialChar LyX
will output
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
is the \SpecialChar LyX
- name of the inset, made lowercase and with non-alphanumeric characters
- converted to underscores, for example: footnote.
+ name of the inset,
+ made lowercase and with non-alphanumeric characters converted to underscores,
+ for example:
+ footnote.
\end_layout
\begin_layout Description
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
+ allows you to alter or augment the generated CSS,
+ rather than to override it completely.
Default is 0.
\end_layout
\end_inset
-] The inner tag, replacing
+] The inner tag,
+ replacing
\begin_inset Flex Code
status collapsed
\end_inset
in the examples above.
- By default, there is none.
+ By default,
+ there is none.
\end_layout
\begin_layout Description
\end_inset
-] Whether this inset represents a standalone block of text (such as a footnote)
- or instead represents material that is included in the surrounding text
- (such as a branch).
+] Whether this inset represents a standalone block of text (such as a footnote) or instead represents material that is included in the surrounding text (such as a branch).
Defaults to 1.
\end_layout
\end_inset
-] A label for this inset, possibly including a reference to a counter.
- For example, for footnote, it might be:
+] A label for this inset,
+ possibly including a reference to a counter.
+ For example,
+ for footnote,
+ it might be:
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- This is optional, and there is no default.
+ This is optional,
+ and there is no default.
\end_layout
\begin_layout Description
\end_inset
section when this style is used.
- This might, for example, be used to include a
+ This might,
+ for example,
+ be used to include a
\begin_inset Flex Code
status collapsed
\end_inset
- block, so only the CSS itself need be included.
+ block,
+ so only the CSS itself need be included.
\end_layout
\begin_layout Description
\end_inset
-] The tag to be used for the main label, replacing
+] The tag to be used for the main label,
+ replacing
\begin_inset Flex Code
status collapsed
\end_inset
-: If
+:
+ If
\begin_inset Flex Code
status collapsed
\end_inset
- is true, the default is
+ is true,
+ the default is
\begin_inset Flex Code
status collapsed
\end_inset
-; if it is false, the default is
+;
+ if it is false,
+ the default is
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The caption, if there is one, is a separate inset and will be output as
- such.
+The caption,
+ if there is one,
+ is a separate inset and will be output as such.
Its appearance can be controlled via the InsetLayout for caption insets.
\end_layout
\end_inset
] Specifies attribute information to be output with the main tag.
- For example,
+ For example,
+
\begin_inset Quotes eld
\end_inset
\end_inset
.
- By default, \SpecialChar LyX
+ By default,
+ \SpecialChar LyX
will output
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+,
+ where
\begin_inset Flex Code
status collapsed
\end_inset
is \SpecialChar LyX
-'s name for this type of float, as determined by the float declaration
- (see
+'s name for this type of float,
+ as determined by the float declaration (see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Floats"
+nolink "false"
\end_inset
-), though made lowercase and with non-alphanumeric characters converted
- to underscores, for example: float-table.
+),
+ though made lowercase and with non-alphanumeric characters converted to underscores,
+ for example:
+ float-table.
\end_layout
\begin_layout Description
\end_inset
- block, so only the CSS itself need be included.
+ block,
+ so only the CSS itself need be included.
\end_layout
\begin_layout Description
\end_inset
-] The tag to be used for this float, replacing
+] The tag to be used for this float,
+ replacing
\begin_inset Quotes eld
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Citation-format-description"
+nolink "false"
\end_inset
\begin_layout Standard
We have several times mentioned that \SpecialChar LyX
- will generate default CSS style rules
- for both insets and paragraph styles, based upon the other layout information
- that is provided.
- In this section, we shall say a word about which layout information \SpecialChar LyX
- uses
- and how.
+ will generate default CSS style rules for both insets and paragraph styles,
+ based upon the other layout information that is provided.
+ In this section,
+ we shall say a word about which layout information \SpecialChar LyX
+ uses and how.
\end_layout
\begin_layout Standard
-At present, \SpecialChar LyX
- auto-generates CSS only for font information, making use of
- the
+At present,
+ \SpecialChar LyX
+ auto-generates CSS only for font information,
+ making use of the
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+
\begin_inset Flex Code
status collapsed
\end_inset
-, and
+,
+ and
\begin_inset Flex Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:Font-description"
+nolink "false"
\end_inset
).
The translation is mostly straightforward and obvious.
- For example,
+ For example,
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-font-family: sans-serif;
+font-family:
+ sans-serif;
\end_layout
\end_inset
.
The correspondence of \SpecialChar LyX
- sizes and CSS sizes is a little less obvious but
- nonetheless intuitive.
+ sizes and CSS sizes is a little less obvious but nonetheless intuitive.
See the
\begin_inset Flex Code
status collapsed
\end_inset
for the details.
-\change_inserted -970929547 1496610908
-
\end_layout
\begin_layout Section
-
-\change_inserted -970929547 1496610966
\begin_inset CommandInset label
LatexCommand label
name "sec:Tags-for-DocBook"
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496611615
As with \SpecialChar LaTeX
- or XHTML, the format of \SpecialChar LyX
-'s DocBook output is also controlled by
- layout information.
- In general, \SpecialChar LyX
- provides sensible defaults; however, much of the styling is
- lost during the conversion, as DocBook is strictly semantic and does not
- allow formatting.
- When possible, information from \SpecialChar LyX
+ or XHTML,
+ the format of \SpecialChar LyX
+'s DocBook output is also controlled by layout information.
+ In general,
+ \SpecialChar LyX
+ provides sensible defaults;
+ however,
+ much of the styling is lost during the conversion,
+ as DocBook is strictly semantic and does not allow formatting.
+ When possible,
+ information from \SpecialChar LyX
will be rendered in
\family typewriter
role
\family default
attributes.
-
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496612080
-In many cases, then, you may not have to do anything at all to get acceptable
- DocBook output for your own environments, custom insets, and so forth.
- But in some cases you will, and so \SpecialChar LyX
- provides a number of layout tags that
- can be used to customize the DocBook that is generated.
+In many cases,
+ then,
+ you may not have to do anything at all to get acceptable DocBook output for your own environments,
+ custom insets,
+ and so forth.
+ But in some cases you will,
+ and so \SpecialChar LyX
+ provides a number of layout tags that can be used to customize the DocBook that is generated.
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1515109912
-Labels are rarely output, as they are redundant in DocBook: this information
- is carried by the tags themselves, and whether labels appear in the final
- documents (after processing of DocBook files) is controlled by the stylesheets.
- However, sometimes, labels are not redundant content, such as definition
- lists: in this case, the term being defined will be the label.
-
+Labels are rarely output,
+ as they are redundant in DocBook:
+ this information is carried by the tags themselves,
+ and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
+ However,
+ sometimes,
+ labels are not redundant content,
+ such as definition lists:
+ in this case,
+ the term being defined will be the label.
\end_layout
\begin_layout Subsection
-
-\change_inserted 1075283030 1597699417
\begin_inset CommandInset label
LatexCommand label
name "subsec:Paragraph-Style-DocBook"
\end_inset
-
-\change_deleted 1075283030 1597699417
-
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Paragraph-Style-XHTML-1"
-
-\end_inset
-
-
-\change_inserted -970929547 1496610966
Paragraph styles
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496612059
The sort of DocBook \SpecialChar LyX
- outputs for a paragraph depends upon whether we are
- dealing with a normal paragraph, a command, or an environment, where this
- is itself determined by the contents of the corresponding
+ outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
+ a command,
+ or an environment,
+ where this is itself determined by the contents of the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
\SpecialChar LaTeX
Type
-\change_unchanged
-
\end_layout
\end_inset
tag.
-
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496612107
-For a command or normal paragraph, the output DocBook has the following
- form:
+For a command or normal paragraph,
+ the output DocBook has the following form:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109666
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
Contents of the paragraph.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1515109821
-For an environment that is not some sort of list, the generated DocBook
- takes this form:
+For an environment that is not some sort of list,
+ the generated DocBook takes this form:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109671
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496612114
<itemtag>First paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
<itemtag>Second paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1515109825
-For a list, the resulting DocBook takes this form:
+For a list,
+ the resulting DocBook takes this form:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109672
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109676
<itemtag attr>First item.</itemtag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109678
<itemtag attr>Second item.</itemtag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496612243
-The specific tags and roles output for each paragraph type can be controlled
- by means of the layout tags we are about to describe.
- Please note that, due to the very nature of DocBook, no sensible defaults
- really exist, and the values must always be carefully chosen.
-
+The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
+ Please note that,
+ due to the very nature of DocBook,
+ no sensible defaults really exist,
+ and the values must always be carefully chosen.
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110057
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515109656
DocBookAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
string
-\change_unchanged
-
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag, replacing
-
+] Specifies attribute information to be output with the main tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110057
attr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1496612296
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496612269
DocBookTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for this inset, replacing
+] The tag to be used for this inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496612296
tag
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
in the example above.
- The default is the name of the float and always needs to be changed, as
- DocBook provides no generic tag.
-\change_inserted 1075283030 1597698868
-
+ The default is the name of the float and always needs to be changed,
+ as DocBook provides no generic tag.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699399
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597698872
DocBookTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597700585
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Subsection
-
-\change_inserted 1075283030 1597699385
New-line policy
\begin_inset CommandInset label
LatexCommand label
\end_layout
\begin_layout Standard
-
-\change_inserted 1075283030 1597698993
-For all tags, there are three possible policies for outputting new lines
- (given in the
+For all tags,
+ there are three possible policies for outputting new lines (given in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597698987
DocBook*TagType
-\change_unchanged
-
\end_layout
\end_inset
- attribute):
+ attribute):
\end_layout
\begin_layout Itemize
-
-\change_inserted 1075283030 1597699279
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699012
block
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-: the opening and closing tags are on their own lines (i.e.
+:
+ the opening and closing tags are on their own lines (i.e.
a line feed after and before the opening and the closing tags).
Typical elements are floats.
- For instance:
+ For instance:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699194
Content before
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699194
<blocktag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699098
Contents of the block.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699196
</blocktag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699198
Content after
\end_layout
\begin_layout Itemize
-
-\change_inserted 1075283030 1597699289
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699113
paragraph
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-: the opening and closing tags are on the same, new line; a line feed is
- output before the opening tag and after the closing tag.
+:
+ the opening and closing tags are on the same,
+ new line;
+ a line feed is output before the opening tag and after the closing tag.
Typical elements are paragraphs and list items.
- For instance:
+ For instance:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699186
Content before
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699357
<paratag>Contents of the paragraph.</paratag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699231
Content after
\end_layout
\begin_layout Itemize
-
-\change_inserted 1075283030 1597699343
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699307
inline
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-: the opening and closing tags are on the same line as the rest of the content.
+:
+ the opening and closing tags are on the same line as the rest of the content.
No line feeds are output.
Typical elements are fonts.
- For instance:
+ For instance:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 1075283030 1597699585
Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
\end_layout
\begin_layout Standard
-
-\change_inserted 1075283030 1597699585
The default value is always
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699585
block
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Subsection
-
-\change_inserted -970929547 1515111533
InsetLayout DocBook
-\change_unchanged
-
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496611894
-The DocBook output of insets can also be controlled by information in layout
- files.
+The DocBook output of insets can also be controlled by information in layout files.
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496612045
The DocBook \SpecialChar LyX
outputs for an inset has the following form:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110861
<wrappertag wrapperattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110868
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110869
<innertag innerattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110869
Contents of the inset.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110870
</innertag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110871
</tag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111172
</wrappertag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1515111186
-For an itemising inset, it rather looks like this:
+For an itemising inset,
+ it rather looks like this:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
<wrappertag wrapperattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
<innertag innerattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111362
<itemwrappertag itemwrapperattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111364
<itemlabeltag itemattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111367
Label of the first item.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111362
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111517
<itemtag itemattr>
\end_layout
\begin_layout LyX-Code
+ <itemtag itemattr>
+\end_layout
-\change_inserted -970929547 1515111517
- <itemtag itemattr>
-\change_unchanged
-
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111516
+\begin_layout LyX-Code
Contents of the first item.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111514
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111247
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111221
</itemwrappertag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111370
<itemwrappertag itemwrapperattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111370
<itemlabeltag itemattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111372
Label of the second item.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111370
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111504
<itemtag itemattr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111505
<itemtag itemattr>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111507
Contents of the second item.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111509
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111251
</itemtag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111221
</itemwrappertag>
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111219
...
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
</innertag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
</tag>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515111186
</wrappertag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1515111183
-If the inset permits multiple paragraphs—that is, if
+If the inset permits multiple paragraphs—
+that is,
+ if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
MultiPar
-\change_unchanged
-
\end_layout
\end_inset
- is true—then the contents of the inset will
-\change_deleted 34634807 1620029217
-itself
-\change_inserted 34634807 1620029219
-themselves
-\change_inserted -970929547 1515111183
- be output as paragraphs formatted according to the styles used for those
- paragraphs (standard, quote, and the like).
- The inner tag is optional and, by default, does not appear.
+ is true—
+then the contents of the inset will themselves be output as paragraphs formatted according to the styles used for those paragraphs (standard,
+ quote,
+ and the like).
+ The inner tag is optional and,
+ by default,
+ does not appear.
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496610966
-The specific tags and attributes output for each inset can be controlled
- by means of the following layout tags.
+The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110317
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515109695
DocBookAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496611854
string
-\change_unchanged
-
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag, replacing
-
+] Specifies attribute information to be output with the main tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110044
attr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110973
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110319
DocBookInInfo
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110384
-never, always, maybe
-\change_unchanged
-
+never,
+ always,
+ maybe
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110412
<info>
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110437
never
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110497
<info>
-\change_unchanged
-
\end_layout
\end_inset
- (this is default value, and corresponds to usual content).
+ (this is default value,
+ and corresponds to usual content).
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110517
always
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110514
<info>
-\change_unchanged
-
\end_layout
\end_inset
- (this corresponds to usual metadata): if there is no
+ (this corresponds to usual metadata):
+ if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110550
<info>
-\change_unchanged
-
\end_layout
\end_inset
- tag for the parent, one
+ tag for the parent,
+ one
\series bold
will
\series default
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110540
maybe
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110538
<info>
-\change_unchanged
-
\end_layout
\end_inset
- (this is only the case for titles): if there is no
+ (this is only the case for titles):
+ if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110585
<info>
-\change_unchanged
-
\end_layout
\end_inset
- tag for the parent,
+ tag for the parent,
+
\series bold
none
\series default
- will be generated, the corresponding tag will be output directly as content.
-
+ will be generated,
+ the corresponding tag will be output directly as content.
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111461
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110974
DocBookItemAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110973
string
-\change_unchanged
-
\end_layout
\end_inset
-] Specifies attribute information to be output with the item tag, replacing
-
+] Specifies attribute information to be output with the item tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110984
itemattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111471
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111465
DocBookItemInnerAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111461
string
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111476
iteminnerattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111494
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111467
DocBookItemInnerTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111461
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the item inner tag within the inset, replacing
-
+] The tag to be used for the item inner tag within the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111486
iteminnertag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111461
NONE
-\change_unchanged
-
\end_layout
\end_inset
-, indicating that there is no item inner tag: content is directly output
- without it for each itemised element.
- This parameter only makes sense when itemising layouts are used, such as
- lists.
-
-\change_inserted 1075283030 1598469472
-The most likely value is
+,
+ indicating that there is no item inner tag:
+ content is directly output without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used,
+ such as lists.
+ The most likely value is
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1598469476
para
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-When a list item is split using a new line, the item inner tag will be repeated
- for each part of the paragraph, parts being separated by new lines.
-
+When a list item is split using a new line,
+ the item inner tag will be repeated for each part of the paragraph,
+ parts being separated by new lines.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699866
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699853
DocBookItemInnerTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699866
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111290
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111283
DocBookItemLabelAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111279
string
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111304
itemlabelattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111337
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111285
DocBookItemLabelTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111279
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the item label tag within the inset, replacing
-
+] The tag to be used for the item label tag within the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111311
itemlabeltag
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
in the example above.
- This parameter only makes sense when itemising layouts are used with a
- notion of labels, such as definition lists.
-
-\change_inserted 1075283030 1597699874
-
+ This parameter only makes sense when itemising layouts are used with a notion of labels,
+ such as definition lists.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699874
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699880
DocBookItemLabelTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699874
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111124
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111060
DocBookItemTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111060
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the item tag within the inset, replacing
+] The tag to be used for the item tag within the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111060
itemtag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111060
NONE
-\change_unchanged
-
\end_layout
\end_inset
-, indicating that there is no item tag.
- This parameter only makes sense when itemising layouts are used, such as
- lists.
-
-\change_inserted 1075283030 1597699890
-
+,
+ indicating that there is no item tag.
+ This parameter only makes sense when itemising layouts are used,
+ such as lists.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699890
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699890
DocBookItemTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699890
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111298
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111124
DocBookItemWrapperAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111124
string
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111150
itemwrapperattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515111113
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111073
DocBookItemWrapperTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111073
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the item wrapper tag within the inset, replacing
-
+] The tag to be used for the item wrapper tag within the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111083
itemwrappertag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515111073
NONE
-\change_unchanged
-
\end_layout
\end_inset
-, indicating that there is no item wrapper tag: tag and content are directly
- output without it for each itemised element.
- This parameter only makes sense when itemising layouts are used, such as
- lists.
-
-\change_inserted 1075283030 1597699897
-
+,
+ indicating that there is no item wrapper tag:
+ tag and content are directly output without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used,
+ such as lists.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699897
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699900
DocBookItemWrapperTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699897
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110104
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
DocBookInnerAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
-string
-\change_unchanged
-
+string
\end_layout
\end_inset
-] Specifies attribute information to be output with the inner tag, replacing
-
+] Specifies attribute information to be output with the inner tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
innerattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
DocBookInnerTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the inner tag within the inset, replacing
+] The tag to be used for the inner tag within the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110104
innertag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110791
NONE
-\change_unchanged
-
\end_layout
\end_inset
-, indicating that there is no inner tag: content is directly output without
- it.
-\change_inserted 1075283030 1597699904
-
+,
+ indicating that there is no inner tag:
+ content is directly output without it.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699904
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699904
DocBookInnerTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699904
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110753
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110665
DocBookSectionTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110661
string
-\change_unchanged
-
\end_layout
\end_inset
] Specifies the tag that corresponds to this kind of section.
- This parameter only makes sense for sectioning elements (part, chapter,
- section, etc.).
+ This parameter only makes sense for sectioning elements (part,
+ chapter,
+ section,
+ etc.).
The default value is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110721
section
-\change_unchanged
-
\end_layout
\end_inset
-, and is only overridden when DocBook uses something else for sectioning
- (
-\change_inserted 1075283030 1597699921
-typically,
-\change_inserted -970929547 1515110753
-parts and chapters of a book).
-
-\change_unchanged
-
+,
+ and is only overridden when DocBook uses something else for sectioning (typically,
+ parts and chapters of a book).
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110811
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496612023
DocBookTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for this inset, replacing
+] The tag to be used for this inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496612033
tag
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
in the example above.
- The default is the name of the float and always needs to be changed, as
- DocBook provides no generic inset tag.
-\change_inserted 1075283030 1597699924
-
+ The default is the name of the float and always needs to be changed,
+ as DocBook provides no generic inset tag.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699924
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699924
DocBookTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699924
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110832
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110822
DocBookWrapperAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110811
string
-\change_unchanged
-
\end_layout
\end_inset
-] Specifies attribute information to be output with the outer
-\change_inserted 34634807 1620057958
-wrapper
-\change_inserted -970929547 1515110832
-tag, replacing
+] Specifies attribute information to be output with the outer wrapper tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110845
wrapperattr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110917
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110826
DocBookWrapperTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110811
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for the wrapper tag around the inset, replacing
+] The tag to be used for the wrapper tag around the inset,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110842
wrappertag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110811
NONE
-\change_unchanged
-
\end_layout
\end_inset
-, indicating that there is no wrapper tag: tag and content are directly
- output without it.
-\change_inserted 1075283030 1597699929
-
+,
+ indicating that there is no wrapper tag:
+ tag and content are directly output without it.
\end_layout
\begin_layout Description
-
-\change_inserted 1075283030 1597699929
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699932
DocBookWrapperTagType
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597699929
-block, paragraph, inline
-\change_unchanged
-
+block,
+ paragraph,
+ inline
\end_layout
\end_inset
-] The new-line policy for this tag, see Section
+] The new-line policy for this tag,
+ see Section
\begin_inset space ~
\end_inset
plural "false"
caps "false"
noprefix "false"
+nolink "false"
\end_inset
for the details.
-
-\change_unchanged
-
\end_layout
\begin_layout Subsection
-
-\change_inserted -970929547 1515110040
Float DocBook
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496611700
The DocBook output for floats too can be controlled by layout information.
The output has the following form:
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515109700
<tag attr>
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1515110138
Contents of the float as DocBook.
\end_layout
\begin_layout LyX-Code
-
-\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-
-\change_inserted -970929547 1496611715
-The caption, if there is one, is a separate inset and will be output as
- a title.
-
+The caption,
+ if there is one,
+ is a separate inset and will be output as a title.
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110033
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515109702
DocBookAttr
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
string
-\change_unchanged
-
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag, replacing
-
+] Specifies attribute information to be output with the main tag,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1515110035
attr
-\change_unchanged
-
\end_layout
\end_inset
in the example above.
This information can be used in further processing of the DocBook files.
-
\end_layout
\begin_layout Description
-
-\change_inserted -970929547 1515110157
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496611782
DocBookTag
-\change_unchanged
-
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
string
-\change_unchanged
-
\end_layout
\end_inset
-] The tag to be used for this float, replacing
+] The tag to be used for this float,
+ replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -970929547 1496610966
tag
-\change_unchanged
-
\end_layout
\end_inset
\end_inset
in the example above.
- The default is the name of the float and always needs to be changed, as
- DocBook provides no generic float tag.
+ The default is the name of the float and always needs to be changed,
+ as DocBook provides no generic float tag.
\end_layout
\begin_layout Subsection
-
-\change_inserted -970929547 1515110157
Bibliography formatting
\end_layout
\begin_layout Standard
-
-\change_deleted 1075283030 1597699984
-The
-\change_inserted 1075283030 1597699985
-Included
-\change_inserted -970929547 1515110187
-bibliograph
-\change_deleted 1075283030 1597699987
-y
-\change_inserted 1075283030 1597699987
-ies
-\change_inserted -970929547 1515110187
- cannot be formatted: all fields are always output in the database-like
- DocBook format (equivalent to a BibTeX file)
-\change_inserted 1075283030 1597700117
-, using the
+Included bibliographies cannot be formatted:
+ all fields are always output in the database-like DocBook format (equivalent to a BibTeX file),
+ using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597700120
biblioentry
-\change_unchanged
-
\end_layout
\end_inset
- tag
-\change_inserted -970929547 1515110187
-.
-\change_inserted 1075283030 1597700092
-
+ tag.
\end_layout
\begin_layout Standard
-
-\change_inserted 1075283030 1597700112
-When the bibliographic entries are manually inserted into the
-\change_deleted 34634807 1620057319
-LyX
-\change_inserted 34634807 1620057319
-\SpecialChar LyX
-
-\change_inserted 1075283030 1597700112
- document as Bibliography Items, the user deals with formatting
-\change_inserted 34634807 1620057261
-him
-\change_deleted 34634807 1620057259
-them
-\change_inserted 1075283030 1597700112
-self: there is no attempt of parsing what the user wrote, the string is
- directly used (with the
+When the bibliographic entries are manually inserted into the \SpecialChar LyX
+ document as Bibliography Items,
+ the user deals with formatting themself:
+ there is no attempt of parsing what the user wrote,
+ the string is directly used (with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1075283030 1597700076
bibliomixed
-\change_unchanged
-
\end_layout
\end_inset
tag).
-
-\change_unchanged
-
\end_layout
\begin_layout Chapter
status open
\begin_layout Plain Layout
-WARNING: This portion of the documentation has not been updated for some
- time.
- We certainly hope that it is still accurate, but there are no guarantees.
+WARNING:
+ This portion of the documentation has not been updated for some time.
+ We certainly hope that it is still accurate,
+ but there are no guarantees.
\end_layout
\end_inset
\begin_layout Standard
The use of material from sources external to \SpecialChar LyX
- is covered in detail in the
-
+ is covered in detail in the
\emph on
Embedded Objects
\emph default
manual.
- This part of the manual covers what needs to happen behind the scenes for
- new sorts of material to be included.
+ This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
\end_layout
\begin_layout Section
\emph default
.
A template is a specification of how \SpecialChar LyX
- should interface with a certain kind
- of material.
- As bundled, \SpecialChar LyX
- comes with predefined templates for Xfig figures, various
- raster format images, chess diagrams, and LilyPond music notation.
+ should interface with a certain kind of material.
+ As bundled,
+ \SpecialChar LyX
+ comes with predefined templates for Xfig figures,
+ various raster format images,
+ chess diagrams,
+ and LilyPond music notation.
You can check the actual list by using the menu
\begin_inset Flex Noun
status collapsed
\end_inset
.
- Furthermore, it is possible to roll your own template to support a specific
- kind of material.
- Later we'll describe in more detail what is involved, and hopefully you
- will submit all the templates you create so we can include them in a later
- \SpecialChar LyX
+ Furthermore,
+ it is possible to roll your own template to support a specific kind of material.
+ Later we'll describe in more detail what is involved,
+ and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
version.
\end_layout
\begin_layout Standard
-Another basic idea of the external material feature is to distinguish between
- the original file that serves as a base for final material and the produced
- file that is included in your exported or printed document.
- For example, consider the case of a figure produced with
+Another basic idea of the external material feature is to distinguish between the original file that serves as a base for final material and the produced file that is included in your exported or printed document.
+ For example,
+ consider the case of a figure produced with
\begin_inset Flex Code
status collapsed
\end_inset
extension.
- Within Xfig, you create and change your figure, and when you are done,
+ Within Xfig,
+ you create and change your figure,
+ and when you are done,
you save the
\begin_inset Flex Code
status collapsed
\end_inset
-file.
- When you want to include the figure in your document, you invoke
+ When you want to include the figure in your document,
+ you invoke
\begin_inset Flex Code
status collapsed
\end_inset
- in order to create a PostScript file that can readily be included in your
- \SpecialChar LaTeX
+ in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
file.
- In this case, the
+ In this case,
+ the
\begin_inset Flex Code
status collapsed
\end_inset
- file is the original file, and the PostScript file is the produced file.
+ file is the original file,
+ and the PostScript file is the produced file.
\end_layout
\begin_layout Standard
-This distinction is important in order to allow updating of the material
- while you are in the process of writing the document.
- Furthermore, it provides us with the flexibility that is needed to support
- multiple export formats.
- For instance, in the case of a plain text file, it is not exactly an award-winn
-ing idea to include the figure as raw PostScript.
- Instead, you would either prefer to just include a reference to the figure
- or try to invoke some graphics to ASCII converter to make the final result
- look similar to the real graphics.
- The external material management allows you to do this, because it is parametri
-zed on the different export formats that \SpecialChar LyX
+This distinction is important in order to allow updating of the material while you are in the process of writing the document.
+ Furthermore,
+ it provides us with the flexibility that is needed to support multiple export formats.
+ For instance,
+ in the case of a plain text file,
+ it is not exactly an award-winning idea to include the figure as raw PostScript.
+ Instead,
+ you would 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 parametrized on the different export formats that \SpecialChar LyX
supports.
\end_layout
\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an Xfig figure, you are able to invoke Xfig on the original
- file with a single click from within the external material dialog in \SpecialChar LyX
+Besides supporting the production of different products according to the exported format,
+ it supports tight integration with editing and viewing applications.
+ In the case of an Xfig figure,
+ you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
,
- and also preview the produced PostScript file with Ghostview with another
- click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
+ and also preview the produced PostScript file with Ghostview with another click.
+ No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
+ In this way,
+ you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
+ and ultimately be more productive.
\end_layout
\begin_layout Section
\begin_layout Standard
It is relatively easy to add custom external template definitions to \SpecialChar LyX
.
- However, be aware that doing this in an careless manner most probably
+ However,
+ be aware that doing this in an careless manner most probably
\emph on
will
\emph default
introduce an easily exploitable security hole.
- So before you do this, please read the discussion about security in
+ So before you do this,
+ please read the discussion about security in
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Security-discussion"
+nolink "false"
\end_inset
\end_layout
\begin_layout Standard
-Having said that, we encourage you to submit any interesting templates that
- you create.
+Having said that,
+ we encourage you to submit any interesting templates that you create.
\end_layout
\end_layout
\begin_layout LyX-Code
-GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+GuiName "XFig:
+ $$AbsOrRelPathParent$$Basename"
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Product "[XFig: $$FName]"
+Product "[XFig:
+ $$FName]"
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-As you can see, the template is enclosed in
+As you can see,
+ the template is enclosed in
\begin_inset Flex Code
status collapsed
\end_inset
.
- It contains a header specifying some general settings and, for each supported
- primary document file format, a section
+ It contains a header specifying some general settings and,
+ for each supported primary document file format,
+ a section
\begin_inset Flex Code
status collapsed
\end_inset
- A glob pattern that is used in the file dialog to filter out the desired
- files.
+ A glob pattern that is used in the file dialog to filter out the desired files.
If there is more than one possible file extension (e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
-), use something like
+),
+ use something like
\begin_inset Flex Code
status collapsed
\end_inset
The help text that is used in the External dialog.
- Provide enough information to explain to the user just what the template
- can provide him with.
+ Provide enough information to explain to the user just what the template can provide him with.
This command must occur exactly once.
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
+nolink "false"
\end_inset
if the template can handle original files of more than one format.
\SpecialChar LyX
- will attempt to interrogate the file itself in order to deduce its format
- in this case.
+ will attempt to interrogate the file itself in order to deduce its format in this case.
This command must occur exactly once.
\end_layout
section for all templates.
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.
+ Then you can at least see a reference to the external material in the exported document.
\end_layout
\begin_layout Description
\end_inset
- This command specifies a preamble snippet that will be included in the
- \SpecialChar LaTeX
+ This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
preamble.
It has to be defined using
\begin_inset Flex Code
\end_inset
- This command denotes files that are created by the conversion process and
- are needed for a particular export format.
- If the filename is relative, it is interpreted relative to the master document.
+ This command denotes files that are created by the conversion process and are needed for a particular export format.
+ If the filename is relative,
+ it is interpreted relative to the master document.
This command may be given zero or more times.
\end_layout
dialog).
This command must occur exactly once.
- If the resulting file format is PDF, you need to specify the format
+ If the resulting file format is PDF,
+ you need to specify the format
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The external template configuration file may contain additional preamble
- definitions enclosed by
+The external template configuration file may contain additional preamble definitions enclosed by
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-When the external material facility invokes an external program, it is done
- on the basis of a command defined in the template configuration file.
+When the external material facility invokes an external program,
+ it is done on the basis of a command defined in the template configuration file.
These commands can contain various macros that are expanded before execution.
Execution always take place in the directory of the containing document.
\end_layout
\begin_layout Standard
-Also, whenever external material is to be displayed, the name will be produced
- by the substitution mechanism, and most other commands in the template
- definition support substitution as well.
+Also,
+ whenever external material is to be displayed,
+ the name will be produced by the substitution mechanism,
+ and most other commands in the template definition support substitution as well.
\end_layout
\begin_layout Standard
\end_inset
- The file path, absolute or relative to the master \SpecialChar LyX
+ The file path,
+ absolute or relative to the master \SpecialChar LyX
document.
\end_layout
\end_inset
- The file path, absolute or relative to the \SpecialChar LyX
+ The file path,
+ absolute or relative to the \SpecialChar LyX
document.
\end_layout
\end_inset
- The absolute file path.
+ The absolute file path
+\change_inserted -712698321 1712390130
+.
+ If compiling with \SpecialChar LyX
+,
+ this is the path to the file in the temporary directory
+\change_unchanged
+.
\end_layout
\begin_layout Description
\begin_inset Quotes erd
\end_inset
- if the file is in JPEG format, otherwise it will be the string
+ if the file is in JPEG format,
+ otherwise it will be the string
\begin_inset Quotes eld
\end_inset
\end_inset
.
- This is useful to avoid uneeded conversions for output formats that support
- both PNG and JPEG fomats.
+ This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
- output
- format.
+ output format.
\end_layout
\begin_layout Description
\end_inset
The filename of the file specified in the external material dialog.
- This is either an absolute name, or it is relative to the \SpecialChar LyX
+ This is either an absolute name,
+ or it is relative to the \SpecialChar LyX
document.
\end_layout
(absolute name or relative to the \SpecialChar LyX
document).
+\change_inserted -712698321 1712389740
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1712390181
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1712389749
+$$OrigAbsName
+\end_layout
+
+\end_inset
+
+ The file name with absolute path to the original directory (not the temporary directory).
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
- The file path, relative to the master \SpecialChar LyX
+ The file path,
+ relative to the master \SpecialChar LyX
document.
\end_layout
\end_inset
- The file path, relative to the \SpecialChar LyX
+ The file path,
+ relative to the \SpecialChar LyX
document.
\end_layout
\end_inset
This macro will expand to the absolute path of the system directory.
- This is typically used to point to the various helper scripts that are
- bundled with \SpecialChar LyX
+ This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
.
\end_layout
\end_inset
- A name and full path to a temporary file which will be automatically deleted
- whenever the containing document is closed, or the external material insertion
- deleted.
+ A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
+ or the external material insertion deleted.
\end_layout
\begin_layout Standard
-All path macros contain a trailing directory separator, so you can construct
- e.
+All path macros contain a trailing directory separator,
+ so you can construct e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
- supports additionally the following substitutions if they are enabled by
- the
+ supports additionally the following substitutions if they are enabled by the
\begin_inset Flex Code
status collapsed
\end_inset
- command supports additionally the following substitutions if they are enabled
- by the
+ command supports additionally the following substitutions if they are enabled by the
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Enumerate
-Relative and absolute file names should remain relative or absolute, respectivel
-y.
+Relative and absolute file names should remain relative or absolute,
+ respectively.
Users may have reasons to prefer either form.
- Relative names are useful for portable documents that should work on different
- machines, for example.
+ Relative names are useful for portable documents that should work on different machines,
+ for example.
Absolute names may be required by some programs.
\end_layout
\begin_layout Enumerate
\SpecialChar LaTeX
treats relative file names differently than \SpecialChar LyX
- and other programs in nested
- included files.
+ and other programs in nested included files.
For \SpecialChar LyX
-, a relative file name is always relative to the document that contains
- the file name.
+,
+ a relative file name is always relative to the document that contains the file name.
For \SpecialChar LaTeX
-, it is always relative to the master document.
- These two definitions are identical if you have only one document, but
- differ if you have a master document that includes part documents.
- That means that relative filenames must be transformed when presented to
- \SpecialChar LaTeX
+,
+ it is always relative to the master document.
+ These two definitions are identical if you have only one document,
+ but differ if you have a master document that includes part documents.
+ That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
.
Fortunately \SpecialChar LyX
does this automatically for you if you choose the right macros.
\end_layout
\begin_layout Standard
-So which path macro should be used in new template definitions? The rule
- is not difficult:
+So which path macro should be used in new template definitions?
+ The rule is not difficult:
\end_layout
\begin_layout Itemize
\begin_inset space \space{}
\end_inset
-relative names are needed, but normally it will work just fine.
+relative names are needed,
+ but normally it will work just fine.
One example for such a case is the command
\begin_inset Flex Code
status collapsed
\end_inset
- in the XFig template above: We can't use the absolute name because the
- copier for
+ in the XFig template above:
+ We can't use the absolute name because the copier for
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-The external material feature interfaces with a lot of external programs
- and does so automatically, so we have to consider the security implications
- of this.
- In particular, since you have the option of including your own filenames
- and/or parameter strings and those are expanded into a command, it seems
- that it would be possible to create a malicious document which executes
- arbitrary commands when a user views or prints the document.
+The external material feature interfaces with a lot of external programs and does so automatically,
+ so we have to consider the security implications of this.
+ In particular,
+ since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
+ it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
This is something we definitely want to avoid.
\end_layout
\begin_layout Standard
-However, since the external program commands are specified in the template
- configuration file only, there are no security issues if \SpecialChar LyX
- is properly configure
-d with safe templates only.
+However,
+ since the external program commands are specified in the template configuration file only,
+ there are no security issues if \SpecialChar LyX
+ is properly configured with safe templates only.
This is so because the external programs are invoked with the
\begin_inset Flex Code
status collapsed
\end_inset
- system-call, so it's not possible to execute arbitrary commands from the
- filename or parameter section via the shell.
+ system-call,
+ so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
\end_layout
\begin_layout Standard
-This also implies that you are restricted in what command strings you can
- use in the external material templates.
- In particular, pipes and redirection are not readily available.
+This also implies that you are restricted in what command strings you can use in the external material templates.
+ In particular,
+ pipes and redirection are not readily available.
This has to be so if \SpecialChar LyX
should remain safe.
- If you want to use some of the shell features, you should write a safe
- script to do this in a controlled manner, and then invoke the script from
- the command string.
+ 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.
\end_layout
\begin_layout Standard
It is possible to design a template that interacts directly with the shell,
- but since this would allow a malicious user to execute arbitrary commands
- by writing clever filenames and/or parameters, we generally recommend that
- you only use safe scripts that work with the
+ but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
+ we generally recommend that you only use safe scripts that work with the
\begin_inset Flex Code
status collapsed
\end_inset
system call in a controlled manner.
- Of course, for use in a controlled environment, it can be tempting to just
- fall back to use ordinary shell scripts.
- If you do so, be aware that you
+ Of course,
+ for use in a controlled environment,
+ it can be tempting to just fall back to use ordinary shell scripts.
+ If you do so,
+ be aware that you
\emph on
will
\emph default
provide an easily exploitable security hole in your system.
- Of course it stands to reason that such unsafe templates will never be
- included in the standard \SpecialChar LyX
- distribution, although we do encourage people
- to submit new templates in the open source tradition.
+ Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
+ distribution,
+ although we do encourage people to submit new templates in the open source tradition.
But \SpecialChar LyX
- as shipped from the official distribution channels will never have
- unsafe templates.
+ as shipped from the official distribution channels will never have unsafe templates.
\end_layout
\begin_layout Standard
-Including external material provides a lot of power, and you have to be
- careful not to introduce security hazards with this power.
- A subtle error in a single line in an innocent looking script can open
- the door to huge security problems.
- So if you do not fully understand the issues, we recommend that you consult
- a knowledgeable security professional or the \SpecialChar LyX
- development team if you have
- any questions about whether a given template is safe or not.
+Including external material provides a lot of power,
+ and you have to be careful not to introduce security hazards with this power.
+ A subtle error in a single line in an innocent looking script can open the door to huge security problems.
+ So if you do not fully understand the issues,
+ we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
+ development team if you have any questions about whether a given template is safe or not.
And do this before you use it in an uncontrolled environment.
\end_layout
\begin_inset Text
\begin_layout Plain Layout
-rotfloat
+rsphrase
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-rsphrase
+setspace
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-pdfcolmk
+pdfpages
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-setspace
+shapepar
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-pdfpages
+pifont
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-shapepar
+slashed
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-pifont
+pmboxdraw
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-slashed
+soul
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-pmboxdraw
+polyglossia
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-soul
+splitidx
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-polyglossia
+prettyref
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-splitidx
+subfig
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-prettyref
+pxfonts
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-subfig
+subscript
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-pxfonts
+refstyle
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-subscript
+tcolorbox
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-refstyle
+rotating
\end_layout
\end_inset
\begin_inset Text
\begin_layout Plain Layout
-rotating
+rotfloat
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-The colors listed below are the standard colors and those that you can adjust
- in the \SpecialChar LyX
+The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
preferences.
\end_layout
\end_layout
\begin_layout Standard
-The following are no real colors, but rather act on color definitions:
+The following are no real colors,
+ but rather act on color definitions:
\end_layout
\begin_layout Description
\end_layout
\begin_layout Standard
-These are fixed colors that cannot be customized
-\change_inserted -712698321 1607683177
-.
+These are fixed colors that cannot be customized.
Please do
\emph on
not
\emph default
- use these colors in layout definitions, since they will not work well with
- some color themes (such as dark themes)
-\change_unchanged
-:
+ use these colors in layout definitions,
+ since they will not work well with some color themes (such as dark themes):
\end_layout
\begin_layout Description
background Background color
\end_layout
+\begin_layout Description
+bookmark Bookmark indicator color
+\end_layout
+
\begin_layout Description
bottomarea Bottom area color
\end_layout
buttonhoverbg Color used for button background under focus
\end_layout
+\begin_layout Description
+buttonhoverbg_broken Color used for broken inset button under focus
+\end_layout
+
\begin_layout Description
changebar Changebar color
\end_layout
changedtextauthor5 Changed text color author 5
\end_layout
+\begin_layout Description
+changedtextcomparison Changed text color document comparison (workarea)
+\end_layout
+
\begin_layout Description
collapsible Collapsible insets text color
\end_layout
commandframe Frame color for command insets
\end_layout
+\begin_layout Description
+command_broken Text color for broken (reference) insets
+\end_layout
+
+\begin_layout Description
+commandbg_broken Background color for broken insets
+\end_layout
+
+\begin_layout Description
+commandframe_broken Frame color for broken insets
+\end_layout
+
\begin_layout Description
comment Label color for comments
\end_layout
\end_layout
\begin_layout Description
-deletedtextmodifier Deleted text modifying color
+deletedtextmodifier Deleted text modifying color (for adjusting the brightness)
\end_layout
\begin_layout Description
selection Background color of selected text
\end_layout
+\begin_layout Description
+selectionmath Foreground color of selected text in math insets
+\end_layout
+
\begin_layout Description
selectiontext Foreground color of selected text
\end_layout
\begin_layout Description
tabularonoffline Table line color
-\change_inserted -712698321 1607682522
-
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1607682563
textlabel1 Color 1 of layout and custom inset labels
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1607682565
textlabel2 Color 2 of layout and custom inset labels
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1607682568
textlabel3 Color 3 of layout and custom inset labels
-\change_unchanged
-
\end_layout
\begin_layout Description
projects / lyx.git / blobdiff