lyx_mirror/lib/doc/LFUNs.lyx

7004 lines
150 KiB
Plaintext
Raw Normal View History

2014-02-10 08:31:46 +00:00
# gen_lfuns.py generated this file. For more info see http://www.lyx.org/
\lyxformat 501
\begin_document
\begin_header
\origin /systemlyxdir/doc/
\textclass article
\begin_preamble
\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
\renewenvironment{description}{\list{}{%
\setlength{\itemsep}{-2pt}
\advance\leftmargini6\p@ \itemindent-12\p@
\labelwidth\z@ \let\makelabel\descriptionlabel}%
}{
\endlist
}
\end_preamble
\use_default_options false
\maintain_unincluded_children false
2014-02-13 09:44:12 +00:00
\begin_local_layout
Style Description
LabelIndent MM
LeftMargin MMMMMxx
End
\end_local_layout
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry true
2012-09-29 16:57:26 +00:00
\use_package amsmath 1
\use_package amssymb 1
2013-08-04 14:40:17 +00:00
\use_package cancel 0
2012-09-29 16:57:26 +00:00
\use_package esint 1
\use_package mathdots 0
\use_package mathtools 0
\use_package mhchem 1
2013-02-03 15:36:45 +00:00
\use_package stackrel 0
\use_package stmaryrd 0
2012-09-29 16:57:26 +00:00
\use_package undertilde 0
\cite_engine basic
2013-08-04 14:40:17 +00:00
\cite_engine_type default
2012-09-29 16:57:26 +00:00
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
2012-09-29 16:57:26 +00:00
\justification true
\use_refstyle 0
\index Index
\shortcut idx
\color #008000
\end_index
\leftmargin 2.5cm
\topmargin 2cm
\rightmargin 3cm
2014-02-10 08:31:46 +00:00
\bottommargin 2.5cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
2014-02-10 08:31:46 +00:00
\begin_layout Title
\SpecialChar LyX
Functions (LFUNs)
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Author
The \SpecialChar LyX
Team
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Date
2015-11-17
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section*
About this manual
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Standard
This manual documents the
\begin_inset Quotes eld
\end_inset
2014-02-13 08:55:40 +00:00
LyX Functions
\begin_inset Quotes erd
\end_inset
2014-02-13 08:55:40 +00:00
(abbreviated LFUNs).
These are commands that are used to make \SpecialChar LyX
perform specific actions.
\SpecialChar LyX
itself uses these functions internally, and every internal action is
2014-02-13 08:55:40 +00:00
bound to an LFUN.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Standard
LFUNs are also used in the files that define keyboard shortcuts, menu or
toolbar items.
So if you want to change\SpecialChar breakableslash
2014-02-13 08:55:40 +00:00
customize the user interface, you need to deal
with LFUNs.
Furthermore, external programs can use LFUNs to communicate with and
\begin_inset Quotes eld
\end_inset
2014-02-13 08:55:40 +00:00
remote-control
\begin_inset Quotes erd
\end_inset
\SpecialChar LyX
.
2014-02-13 08:55:40 +00:00
Finally, you can also issue LFUNs directly via the so called mini-buffer
which can be opened via
\begin_inset Info
type "shortcuts"
arg "command-execute"
\end_inset
2014-02-13 08:55:40 +00:00
.
\end_layout
\begin_layout Standard
In the following, all LFUNs are listed, categorized by function.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
Layout Functions (Font, Layout and Textclass related)
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
drop-layouts-choice
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Displays list of layout choices.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax drop-layouts-choice
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
environment-split
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Splits the current environment with a Separator.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax environment-split [outer]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin spitz, 23 Dec 2012
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-bold
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the bold font (selection-wise) using mathbf in math.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-bold
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-boldsymbol
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the bold font (selection-wise) using boldsymbol in math.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-boldsymbol
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-default
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reverts the settings of the font to the default values (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-default
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-emph
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the emphasis font style (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-emph
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-frak
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles Fraktur family font (math-mode, selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-frak
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin vermeer, 10 Jan 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-ital
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles Italics font shape (math-mode, selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-ital
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin vermeer, 10 Jan 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-noun
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles Noun text style font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-noun
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-roman
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles Roman family font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-roman
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-sans
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles Sans Serif family font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-sans
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-size
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets font size according to lyx format string.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-size <SIZE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
\begin_inset Newline newline
\end_inset
largest|huge|giant|increase|decrease|default
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-state
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Returns the info about the current font.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-state
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-strikeout
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles strikeout (strike-through) in the font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-strikeout
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sanda, 3 May 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-typewriter
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the typewriter family font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-typewriter
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-underline
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles underline in the font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-underline
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-underunderline
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles double underline in the font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-underunderline
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
font-underwave
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles wavy underline in the font (selection-wise).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax font-underwave
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
layout
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets the layout (that is, environment) for the current paragraph.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout <LAYOUT>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LAYOUT>: the layout to use
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
layout-module-add
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a module.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Adds a module to the list of included modules for the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout-module-add <MODULE>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <MODULE>: the module to be added
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
layout-modules-clear
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Clears the module list.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Clears the list of included modules for the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout-modules-clear
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
layout-paragraph
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Launches the paragraph settings dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout-paragraph
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
layout-reload
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reloads layout information.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout-reload
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin rgh, 3 September 2007
\end_layout
2014-02-10 08:31:46 +00:00
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
layout-tabular
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Launches the tabular settings dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax layout-tabular
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Jug, 31 Jul 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-font-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Update fonts and its metrics.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Automatically called after zoom, dpi, font names, or norm change.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-font-update
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin ARRae, 13 Aug 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
textclass-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets the text class for the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax textclass-apply <TEXTCLASS>
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
textclass-load
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Loads information for a textclass from disk.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax textclass-load <TEXTCLASS>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
textstyle-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggle user-defined (=last-time used) text style.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax textstyle-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 12 Mar 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
textstyle-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax textstyle-update <FONT_INFO>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
Use lyx -dbg action for exact syntax of text-style dialog parameters.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 12 Mar 2003
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-acute
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds an acute accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-acute
\end_layout
\begin_layout Subsection*
accent-breve
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a breve accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-breve
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-caron
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a caron to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-caron
\end_layout
\begin_layout Subsection*
accent-cedilla
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a cedilla to the next character typed.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-cedilla
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-circle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a circle accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-circle
\end_layout
\begin_layout Subsection*
accent-circumflex
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a circumflex to the next character typed.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-circumflex
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-dot
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a dot accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-dot
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-grave
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a grave accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-grave
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
accent-hungarian-umlaut
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a Hungarian umlaut to the next character typed.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-grave
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-macron
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a macron to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-macron
\end_layout
\begin_layout Subsection*
accent-ogonek
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds an ogonek accent to the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-ogonek
\end_layout
\begin_layout Subsection*
accent-perispomeni
\end_layout
\begin_layout Description
Action Adds a perispomeni (Greek circumflex) over the next character typed.
\end_layout
\begin_layout Description
Syntax accent-perispomeni
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-tie
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a tie over the next two character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The following char will finish the tie.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-tie
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-tilde
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a tilde over the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-tilde
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-umlaut
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds an umlaut over the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-umlaut
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
accent-underbar
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a bar under the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-underbar
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
accent-underdot
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds a dot under the next character typed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax accent-underdot
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
all-changes-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Accepts all tracked changes in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax all-changes-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
all-changes-reject
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Rejects all tracked changes in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Reject does not work recursively; the user may have to repeat the operation.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax all-changes-reject
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
appendix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Start (or remove) Appendix on the given cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax appendix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin ettrich, 5 May 1998
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
argument-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax argument-insert <argument nr>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <argument nr>: see layout declarations
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vermeer, 12 Aug 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
bibtex-database-add
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax bibtex-database-add <DATABASE-NAME>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
bibtex-database-del
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax bibtex-database-del <DATABASE-NAME>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
bookmark-clear
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Clears the list of saved bookmarks.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax bookmark-clear
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin bpeng, 31 October 2006
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
bookmark-goto
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Bookmark 0 has a special purpose. It is automatically set
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
1. to the paragraph you are currently editing
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax bookmark-goto <NUMBER>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <NUMBER>: the number of the bookmark to restore.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Dekel, 27 January 2001
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
bookmark-save
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Save a bookmark.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax bookmark-save <NUMBER>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NUMBER>: the number of the bookmark to save.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Dekel, 27 January 2001
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
box-insert
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts Box inset.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax box-insert [<TYPE>]
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
\begin_inset Newline newline
\end_inset
Framed is the default one.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vermeer, 7 Oct 2003
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-insert
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts branch inset.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-insert <BRANCH-NAME>
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vermeer, 17 Aug 2003
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-begin
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-begin
\end_layout
\begin_layout Subsection*
buffer-begin-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the document adding the traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-begin-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-end
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-end
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-end-select
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the document adding the traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-end-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
caption-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a caption inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax caption-insert
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 18 Jul 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
cell-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the previous cell inside the table.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax cell-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Jug, 22 May 2000
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
cell-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the next cell inside the table.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax cell-forward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
cell-split
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Splits cell and shifts right part to the next cell (inside the math grid).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax cell-split
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ale, 15 May 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
change-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Accepts tracked change inside the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax change-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
change-next
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the position of the next change of the change tracking records.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax change-next
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin schmitt, 4 Oct 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
change-previous
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the position of the previous change of the change tracking records.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax change-previous
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 4 Apr 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
change-reject
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Rejects tracked change inside the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax change-reject
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
changes-merge
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax changes-merge
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
changes-output
\end_layout
\begin_layout Description
2014-02-13 13:20:43 +00:00
Action Toggles showing of change tracking in typeset output.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax changes-output
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin jspitzm, 21 Jan 2005
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
changes-track
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles change tracking to on/off.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax changes-track
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin levon, 1 Oct 2002
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position logically backwards.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-backward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-backward-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position logically backwards, adding traversed position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_CHAR_BACKWARD.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-backward-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-delete-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Deletes one character in the backward direction (usually the "BackSpace" key).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-delete-backward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-delete-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Deletes one character in the backward direction (usually the "Delete" key).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-delete-forward
\end_layout
\begin_layout Subsection*
char-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position logically forward.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax char-forward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-forward-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position logically forward, adding traversed position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_CHAR_FORWARD.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-forward-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-left
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position "to the left".
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-left
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-left-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position "to the left", adding traversed position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_CHAR_LEFT for exact details of the movement.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax char-left-select
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
char-right
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position "to the right".
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax char-right
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
char-right-select
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one position "to the right", adding traversed position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax char-right-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
chars-transpose
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Transposes the character at the cursor with the one before it.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax chars-transpose
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 25 Apr 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
citation-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts citation from loaded citation database.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <KEY>: Citation (shortcut listed in available citations).
\begin_inset Newline newline
\end_inset
<TEXT_BEFORE>: text which should appear before citation.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin AAS, 97-02-23
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
clipboard-paste
\end_layout
\begin_layout Description
2014-02-13 13:20:43 +00:00
Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax clipboard-paste [<ARG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Georg, 10 Jul 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
clipboard-paste-simple
\end_layout
\begin_layout Description
2014-02-13 13:20:43 +00:00
Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax clipboard-paste-simple [<ARG>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
command-execute
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Usually bound to M-x shortcut.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax command-execute
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
complete
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Try to complete the word or command at the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax complete
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
completion-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Accept suggested completion.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax completion-accept
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, Sep 08 2008
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
completion-cancel
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Try to cancel completion, either the popup or the inline completion.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax completion-cancel
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, Sep 07 2008
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
completion-inline
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Show the inline completion at the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax completion-inline
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
completion-popup
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Show the completion popup at the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax completion-popup
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
copy
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Copies the current selection to the clipboard.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax copy
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
cut
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Cuts to the clipboard.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax cut
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
date-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts the current date.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax date-insert [<ARG>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin jdblair, 31 Jan 2000
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
depth-decrement
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax depth-decrement
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
depth-increment
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax depth-increment
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-disconnect-inset
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Closes opened connection to opened inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Connection is used for apply functions.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-disconnect-inset <INSET-NAME>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-hide
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-hide <NAME>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params See LFUN_DIALOG_SHOW .
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-show
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Shows hidden dialog or creates new one for a given function/inset settings etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-show <NAME> [<DATA>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
\begin_inset Newline newline
\end_inset
compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
\begin_inset Newline newline
\end_inset
graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
\begin_inset Newline newline
\end_inset
mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
\begin_inset Newline newline
\end_inset
print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
\begin_inset Newline newline
\end_inset
thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
\begin_inset Newline newline
\end_inset
<SPECIAL>: latexlog|vclog
\begin_inset Newline newline
\end_inset
<DATA>: data, usually settings for the given dialog. Use debug mode for the details.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin leeming, 17 Jun 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-show-new-inset
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Shows hidden dialog or create new one for a given inset settings etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-show-new-inset <NAME> [<DATA>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params See LFUN_DIALOG_SHOW .
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles dialog between showed/hidden state.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-toggle <NAME> [<DATA>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params See LFUN_DIALOG_SHOW .
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin JSpitzm, 30 Apr 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
dialog-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Updates the dialog values from the inset/paragraph/document.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax dialog-update <NAME>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: paragraph|prefs|<INSET>
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<INSET>: inset name
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
down
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one line in downward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax down
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
down-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one line in downward direction adding the current position to the selection.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax down-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
ert-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts an ERT inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax ert-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Jug, 18 Feb 2000
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
escape
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax escape
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 17 May 2001
\end_layout
\begin_layout Subsection*
file-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts another LyX file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax file-insert [<FILE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: Filename to be inserted.
\end_layout
2013-08-04 14:40:17 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
file-insert-plaintext
2013-08-04 14:40:17 +00:00
\end_layout
2013-08-04 14:40:17 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts plain text file.
2013-08-04 14:40:17 +00:00
\end_layout
2013-08-04 14:40:17 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax file-insert-plaintext [<FILE>]
2013-08-04 14:40:17 +00:00
\end_layout
2013-08-04 14:40:17 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: Filename to be inserted.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin CFO-G, 19 Nov 1997
2013-08-04 14:40:17 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
file-insert-plaintext-para
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts plain text file as paragraph (i.e. join lines).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax file-insert-plaintext-para [<FILE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: Filename to be inserted.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Levon, 14 Feb 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
flex-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts CharStyle, Custom inset or XML short element.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Look into the Customization manual for more information about these elements.
\begin_inset Newline newline
\end_inset
To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself.
\begin_inset Newline newline
\end_inset
For dissolving the element see LFUN_INSET_DISSOLVE.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax flex-insert Name
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample flex-insert Code
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
float-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a float inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax float-insert <TYPE>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 27 Jun 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
float-list-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts the list of floats in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax float-list-insert <TYPE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 3 May 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
float-wide-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax float-wide-insert <TYPE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 31 Oct 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
footnote-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a footnote inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax footnote-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Jug, 7 Mar 2000
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
graphics-reload
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reloads the image if necessary.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax graphics-reload
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 10 Aug 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
href-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts hyperlinks into the document (clickable in pdf output).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Hyperlink target can be set via selection + hyperlink-insert function.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax href-insert [<TARGET>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin CFO-G, 21 Nov 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
in-ipa
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Only active in IPA inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax in-ipa
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin spitz, 20 May 2012
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
index-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts Index entry.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion It automatically takes the word on the cursor position.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax index-insert [<TYPE:Name>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 3 Aug 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
index-print
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts list of Index entries on a new page.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax index-print [<TYPE:Name>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 27 Feb 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
info-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Apart from lfun arguments you can use the following method:
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
1. input the type and argument of this inset, e.g. "menu paste", in the work area.
\begin_inset Newline newline
\end_inset
2. select the text and run info-insert lfun.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax info-insert <TYPE> <ARG>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
shortcut[s]: name of lfun (e.g math-insert
\backslash
alpha)
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
lyxrc: name of rc_entry (e.g. bind_file)
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
lyxinfo: "version" - used version of LyX
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
package: name of latex package (e.g. listings)
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
textclass: name of textclass (e.g. article)
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
menu: name of lfun used in menu
\begin_inset Newline newline
\end_inset
icon: icon of lfun used in toolbar or direct icon name
2014-02-13 08:55:40 +00:00
\begin_inset Newline newline
\end_inset
buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample command-sequence info-insert buffer path; info-insert buffer name
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin bpeng, 7 Oct 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Apply data for an inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-apply <ARGS>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params See LFUN_INSET_INSERT .
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-begin
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise
2012-09-29 16:57:26 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-begin
2014-02-10 08:31:46 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 16 Mar 2009
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-begin-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-begin-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 16 Mar 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-copy-as
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Copies the inset to the clipboard as a certain type.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Currently used only for InsetInfo where its content is copied as a text.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-copy-as
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin vfr, 18 Apr 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-dissolve
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Dissolve the current inset into text.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-dissolve [<INSET>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <INSET>: this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type.
\begin_inset Newline newline
\end_inset
For values see lyx::InsetLayout::lyxtype_ .
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitz, 7 Aug 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-edit
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Edit the inset at cursor with an external application, if one is attributed.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-edit [<INSET_PARAMS>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <INSET_PARAMS>: Parameters for the inset.
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
Currently only the filename will be considered.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitzm, 27 Apr 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-end
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-end
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 16 Mar 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-end-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-end-select
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 16 Mar 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-forall
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Apply the given commands on insets of a given name.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-forall <NAME> <LFUN-COMMAND>
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample Remove all index insets:
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
inset-forall Index char-delete-forward
\begin_inset Newline newline
\end_inset
Close all Notes (also works for a particular branch, for example):
\begin_inset Newline newline
\end_inset
inset-forall Note inset-toggle close
\begin_inset Newline newline
\end_inset
Transform all yellow notes to comments
\begin_inset Newline newline
\end_inset
inset-forall Note:Note inset-modify note Note Comment
\begin_inset Newline newline
\end_inset
Try to put LyX in an infinite loop if there is at least a Note:
\begin_inset Newline newline
\end_inset
inset-forall Note char-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 27 Nov 2009
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-insert
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Insert new inset (type given by the parameters).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-insert <INSET> <ARGS>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
\begin_inset Newline newline
\end_inset
hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
\begin_inset Newline newline
\end_inset
<ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample inset-insert ref LatexCommand <Format> reference "<label name>"
\backslash
end_inset
\begin_inset Newline newline
\end_inset
where <label name> is the name of the referenced label and <Format> is one of the following:
\begin_inset Newline newline
\end_inset
ref -- <reference>
\begin_inset Newline newline
\end_inset
eqref -- (<reference>)
\begin_inset Newline newline
\end_inset
pageref -- <page>
\begin_inset Newline newline
\end_inset
vpageref -- on <page>
\begin_inset Newline newline
\end_inset
vref -- <reference> on <page>
\begin_inset Newline newline
\end_inset
formatted -- Formatted reference
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-modify
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Modify some properties of an inset.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params Generally see LFUN_INSET_INSERT for further details.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
\begin_inset Newline newline
\end_inset
copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
\begin_inset Newline newline
\end_inset
toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
\begin_inset Newline newline
\end_inset
align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
\begin_inset Newline newline
\end_inset
valign-top|valign-bottom|valign-middle|longtabular-align-left|
\begin_inset Newline newline
\end_inset
longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
\begin_inset Newline newline
\end_inset
m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
\begin_inset Newline newline
\end_inset
set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|
2014-02-13 08:55:40 +00:00
\begin_inset Newline newline
\end_inset
set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
\begin_inset Newline newline
\end_inset
set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
\begin_inset Newline newline
\end_inset
unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
\begin_inset Newline newline
\end_inset
set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
\begin_inset Newline newline
\end_inset
set-special-column|set-special-multicolumn|set-special-multirow|
\begin_inset Newline newline
\end_inset
toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2014-02-13 08:55:40 +00:00
\begin_inset Newline newline
\end_inset
set-interline-space|set-border-lines|tabular-valign-top|
\begin_inset Newline newline
\end_inset
tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample inset-modify note Note Comment
\begin_inset Newline newline
\end_inset
inset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
inset-select-all
\end_layout
\begin_layout Description
Action Select all contents of an inset.
\end_layout
\begin_layout Description
Notion There are 3 successive levels: select current cell, select all cells of inset, select the inset from outside (in the enclosing inset).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-select-all
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-settings
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Open the inset's properties dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-settings <INSET>
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
\begin_inset Newline newline
\end_inset
graphics|href|include|index|index_print|label|line|
\begin_inset Newline newline
\end_inset
listings|note|phantom|ref|space|tabular|vspace|wrap>.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
inset-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax inset-toggle [<ARG>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: <open|close|toggle|assign>.
\begin_inset Newline newline
\end_inset
open/close/toggle are for collapsible insets. toggle is used when no argument is given.
\begin_inset Newline newline
\end_inset
assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, 19 Jul 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
ipa-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts an IPA inset.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax ipa-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin spitz, 05 Mar 2012
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
ipamacro-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts special IPA macros into the document.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax ipamacro-insert <CHAR>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitzm, 22 Aug 2012
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
keymap-off
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Turn off the loaded keyboard map.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax keymap-off
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
keymap-primary
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Turn on the primary keyboard map.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Maps were widely used in past, when X-windows didn't have nowadays keyboard support. They can be still used to maintain uniform keyboard layout across the various platforms.
\begin_inset Newline newline
\end_inset
The language is to be set in the Preferences dialog.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax keymap-primary
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
keymap-secondary
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Turn on the secondary keyboard map.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax keymap-secondary
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
keymap-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles keyboard maps (first/second/off).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax keymap-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
label-copy-as-reference
\end_layout
\begin_layout Description
Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
\end_layout
\begin_layout Description
Syntax copy-label-as-reference <LABEL>
\end_layout
\begin_layout Description
Params <LABEL>: The label to copy (for multi-line math)
\end_layout
\begin_layout Description
Origin sts, 16 Nov 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
label-goto
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Goto a label.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax label-goto [<LABEL>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LABEL>: Requested label. If no label is given and reference is on cursor position, Bookmark 0 is saved and cursor moves to the position of referenced label.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Ale, 6 Aug 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
label-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts label to text or displayed formula.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax label-insert [<LABEL>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
label-insert-as-reference
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax label-insert-as-reference
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 7 Apr 2009
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
language
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Set language from the current cursor position.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax language <LANG> [set]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Dekel, 2 Mar 2000
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
line-begin
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the (screen) line.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax line-begin
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
line-begin-select
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax line-begin-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
line-delete-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Deletes the letters to the end of the (screen) line or deletes the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax line-delete-forward
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
line-end
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the (screen) line.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax line-end
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
line-end-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax line-end-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
listing-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a new listings inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax listing-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
marginalnote-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a marginal note.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax marginalnote-insert
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 26 Jun 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
mark-off
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Disable selecting of text-region.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax mark-off
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
mark-on
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Enable selecting of text-region.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion After enabling you can simply move arrow keys to get selected region.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax mark-on
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
mark-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax mark-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, May 5 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
newline-insert
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a line break or new line.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax newline-insert [<ARG>]
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: <newline|linebreak> default: newline
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitzm, 25 Mar 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
newpage-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a new page.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax newpage-insert <ARG>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin uwestoehr, 24 Nov 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
nomencl-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts Nomenclature entry.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion It automatically takes the word on the cursor position if no symbol is given.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax nomencl-insert [<SYMBOL>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ugras, 4 Nov 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
nomencl-print
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts list of Nomenclature entries.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax nomenclature-print
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ugras, 4 Nov 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
note-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts Note on the current cursor position, move selection inside the inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax note-insert [<TYPE>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: <Note|Greyedout|Comment> default: Note
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
note-next
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the beginning of next Note inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax note-next
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
outline-down
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the current group in the downward direction in the structure of the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax outline-down
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
outline-in
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the current group in the downward direction in the hierarchy of the document structure.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Part -> Chapter -> Section -> etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax outline-in
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
outline-out
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the current group in the upward direction in the hierarchy of the document structure.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Part <- Chapter <- Section <- etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax outline-out
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
outline-up
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the current group in the upward direction in the structure of the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax outline-up
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Vermeer, 23 Mar 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-break
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Breaks the current paragraph at the current location.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Removes the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-break [<LAYOUT>]
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-down
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-down
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 1 Oct 1996
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
paragraph-down-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-down-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 1 Oct 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-goto
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <PAR_ID_NUMBER>: paragraph id
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<POSITION_IN_PAR>: desired position within the paragraph
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Dekel, 26 Aug 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-move-down
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the current paragraph downwards in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-move-down
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Edwin, 8 Apr 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-move-up
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the current paragraph upwards in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-move-up
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Edwin, 8 Apr 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-params
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Change paragraph settings.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Modifies the current paragraph, or currently selected paragraphs. This function only modifies, and does not override, existing settings. Note that the "leftindent" indent setting is deprecated.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <INDENT>:
\backslash
noindent|
\backslash
indent|
\backslash
indent-toggle|
\backslash
leftindent LENGTH
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
<SPACING>:
\backslash
paragraph_spacing default|single|onehalf|double|other SIZE
\begin_inset Newline newline
\end_inset
<ALIGN>:
\backslash
align block|left|right|center|default
\begin_inset Newline newline
\end_inset
<OTHERS>:
\backslash
labelwidthstring WIDTH|
\backslash
start_of_appendix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin rgh, Aug 15 2007
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-params-apply
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Change paragraph settings.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params For parameters see LFUN_PARAGRAPH_PARAMS
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-up
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-up
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Asger, 1 Oct 1996
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paragraph-up-select
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paragraph-up-select
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 1 Oct 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
paste
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Pastes material (text or picture) from the active clipboard.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax paste [<TYPE>|<NUM>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
\begin_inset Newline newline
\end_inset
<NUM>: number of the selection in the internal clipboard stack to be pasted.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
phantom-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts phantom on the current cursor position, move selection inside the inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax phantom-insert [<TYPE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin uwestoehr, 30 Jan 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
preview-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a new preview inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax preview-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 28 Mar 2010
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
primary-selection-paste
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Pastes the currently selected text.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Primary selection mechanism is linux-only thing.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax primary-selection-paste [<ARG>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
quote-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts quotes according to the type and quote-language preference.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax quote-insert [<TYPE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
redo
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Redoes the last thing undone.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax redo
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
reference-next
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Go to the next label or cross-reference.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax reference-next
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Dekel, 14 Jan 2001
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
repeat
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Repeat the given command.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax repeat <COUNT> <LFUN-COMMAND>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 27 Oct 2003
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-down
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one page in downward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-down
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-down-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one screen in downward direction adding the current position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-down-select
\end_layout
\begin_layout Subsection*
screen-recenter
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Recenters the screen on the current cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-recenter
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-show-cursor
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Repositions the screen such that the cursor is visible.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-show-cursor
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 25 Mar 2009
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-up
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one page in upward direction.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-up
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
screen-up-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one page in upward direction adding the current position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax screen-up-select
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
script-insert
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax script-insert <TYPE>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <TYPE>: subscript|superscript
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Georg, 23 Nov 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
scroll
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Scroll the buffer view.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Only scrolls the screen up or down; does not move the cursor.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax scroll <TYPE> <QUANTITY>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: line|page
\begin_inset Newline newline
\end_inset
<QUANTITY>: up|down|<number>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Abdel, Dec 27 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
section-select
\end_layout
\begin_layout Description
Action Select the whole section.
2014-02-13 08:55:40 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Notion The cursor should be in a section heading before calling this lfun.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax section-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 05 May 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
selection-paste
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Pastes the internal selection text in permanent selection.
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax selection-paste
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin lasgouttes, 14 Jan 2009
\end_layout
\begin_layout Subsection*
separator-insert
\end_layout
\begin_layout Description
Action Inserts an environment separator or paragraph break.
\end_layout
\begin_layout Description
Syntax separator-insert [<ARG>]
\end_layout
\begin_layout Description
Params <ARG>: <plain|parbreak> default: plain
\end_layout
\begin_layout Description
Origin ef, 2 May 2014
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
set-graphics-group
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Set the group for the graphics inset on the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax set-graphics-group [<GROUP>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sanda, 6 May 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
space-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts one of horizontal space insets.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax space-insert <NAME> [<LEN>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
Only in math mode: med and thick.
\begin_inset Newline newline
\end_inset
<LEN>: length for custom spaces (hspace, hspace* for protected)
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitzm, 20 May 2003, Mar 17 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
specialchar-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts various characters into the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax specialchar-insert <CHAR>
\end_layout
\begin_layout Description
Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
2014-02-13 08:55:40 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin JSpitzm, 6 Dec 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
spelling-add
\end_layout
\begin_layout Description
Action Add the word under the cursor to the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax spelling-add [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <WORD>: word to add <LANG>: language name (see file languages)
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin JSpitzm, 18 Jan 2010
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
spelling-continuously
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggle continuous spell checking.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax spelling-continuously
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 24 March 2013
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
spelling-ignore
\end_layout
\begin_layout Description
Action Let the spell checker ignore the word under the cursor in the current session for the given language. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax spelling-ignore [<WORD>] [<LANG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <WORD>: word to ignore <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin JSpitzm, 18 Jan 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
spelling-remove
\end_layout
\begin_layout Description
Action Remove the word under the cursor from the respective spell checker dictionary. The default for the language is retrieved from the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax spelling-remove [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <WORD>: word to remove <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin SWitt, 28 July 2010
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
tab-delete
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax tab-delete
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
tab-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Insert a tab into a listings inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion It also works on a selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax tab-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
tabular-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts table into the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax tabular-insert [<ROWS> <COLUMNS>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params In case no arguments are given show insert dialog.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Jug, 12 Apr 2000
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
thesaurus-entry
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Look up thesaurus entries with respect to the word under the cursor.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <STRING>: word to look up <LANG>: language (see file languages)
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Levon, 20 Jul 2001
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
undo
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Undoes the last edit.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax undo
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
unicode-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a single unicode character.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax unicode-insert <CHAR>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample unicode-insert 0x0100
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 22 Oct 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
up
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one line in upward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax up
\end_layout
\begin_layout Subsection*
up-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor one line in upward direction adding the current position to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax up-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the logically previous beginning of a word.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-backward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-backward-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_WORD_BACKWARD.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-backward-select
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
word-capitalize
\end_layout
\begin_layout Description
Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
2014-02-13 08:55:40 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax word-capitalize [<SEL_TYPE>]
\end_layout
\begin_layout Description
Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-delete-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-delete-backward
\end_layout
\begin_layout Subsection*
word-delete-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Deletes characters to the end of the word (usually the "C+Delete" key).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-delete-forward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-find
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Search for next occurrence of a string.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-find [<DATA>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-find-backward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Search for a given string in backward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Case sensitive, match words. If no argument given, last search repeated.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-find-backward [<STRING>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Etienne, 20 Feb 1998
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-find-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Search for a given string in forward direction.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Case sensitive, match words. If no argument given, last search repeated.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-find-forward [<STRING>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Etienne, 16 Feb 1998
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-findadv
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Search for next occurrence of a pattern.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-findadv [<DATA>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Tommaso, Nov 15 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-forward
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the logically next beginning of a word.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-forward
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-forward-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_WORD_FORWARD.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-forward-select
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-left
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the next beginning of a word "on the left".
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-left
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-left-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_WORD_LEFT for exact details of the movement.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-left-select
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-lowcase
\end_layout
\begin_layout Description
Action Change the words in the selection or word at cursor position to lower case.
\end_layout
\begin_layout Description
Syntax word-lowcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
2014-02-13 08:55:40 +00:00
\end_layout
\begin_layout Subsection*
word-replace
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Replace a string in the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-replace [<DATA>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <DATA>: data is of the form "<replace>
\begin_inset Newline newline
\end_inset
<search>
\begin_inset Newline newline
\end_inset
<casesensitive> <matchword> <all> <forward> <findnext>"
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-right
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the next beginning of a word "on the right".
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-right
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-right-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion See also LFUN_WORD_RIGHT for exact details of the movement.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-right-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
word-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Puts the word where the cursor stands into the selection.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax word-select
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 11 Sep 2002
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
word-upcase
\end_layout
\begin_layout Description
Action Change the words in the selection or word at cursor position to upper case.
2014-02-13 08:55:40 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax word-upcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
Params <SEL_TYPE>: if this is equal to "partial", then the default word starts at cursor position (emacs-style). Otherwise, the whole word is considered.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
wrap-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts floats wrapped by the text around.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax wrap-insert <TYPE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: table|figure
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Dekel, 7 Apr 2002
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
Math Editor Functions
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
in-mathmacrotemplate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Only active in Math Macro definition.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Dummy function which is only active in a Math Macro definition. It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax in-mathmacrotemplate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-ams-matrix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts an extended matrix as provided by the amsmath package.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and matrix. The default is 'matrix'.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample math-ams-matrix 3 3 bmatrix
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-bigdelim
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
\begin_inset Newline newline
\end_inset
<L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample math-bigdelim "Bigl" "
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
Downarrow" "Bigr" "
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
}"
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Enrico & Georg, 7 May 2006
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-delim
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-delim [<LEFT>] [<RIGHT>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample math-delim { rangle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-display
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-display [<ARG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-extern
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Selection can be used to determine the input for the external program.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-extern <LANG> [<COMMAND>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LANG>: octave|maxima|maple|mathematica|script
\begin_inset Newline newline
\end_inset
where "script" stands for the external script (normalized expression will be passed)
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample math-extern maple simplify
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 24 Apr 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-font-style
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Changes the text style used in math.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-font-style <STYLE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 9 jan 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-insert
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Inserts math objects and symbols.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
\backslash
frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
\backslash
frac{x}{y}" replaces "abc" with "
\backslash
frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-insert <ARG>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: Symbol or LaTeX code to be inserted.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-limits
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Put the cursor before the symbol with the limits and then invoke math-limits.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-limits [<STATE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <STATE>: limits|nolimits
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Inserts a math macro definition at the cursor position in the text.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro <NAME> [<NARGS>] [def]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: The name of the macro, e.g. "mymacro".
\begin_inset Newline newline
\end_inset
<NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin ale, 10 May 1997; sts, 21 Dec 2007
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-add-greedy-optional-param
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Add a greedy optional parameter.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-add-greedy-optional-param
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-add-optional-param
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Add an optional parameter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Insert an optional parameter just behind the already existing optional parameters.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-add-optional-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-add-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Add a parameter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Add a parameter to a Math Macro.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax math-macro-add-param <NUM>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NUM>: The number of the parameter behind which the new one will be added (1 for the first, i.e. use 0 for add a parameter at the left), defaults to the last one.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-append-greedy-param
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Append a greedy parameter.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-append-greedy-param
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-fold
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Fold a Math Macro.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
\backslash
foo before.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-fold
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-make-nonoptional
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Make a parameter non-optional.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Turn the last optional parameter of a Math Macro into a non-optional parameter. The default value is remembered to be reused later if the user changes his mind.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-make-nonoptional
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-make-optional
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Make a parameter optional.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-make-optional
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-remove-greedy-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Remove a greedy parameter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer. If it is an optional parameter the [valud] format is used.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-remove-greedy-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-remove-optional-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Remove the last optional parameter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-remove-optional-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-remove-param
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Remove the last parameter.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-remove-param <NUM>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-macro-unfold
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Unfold a Math Macro.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Unfold the Math Macro the cursor is in, i.e. display it as
\backslash
foo.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-macro-unfold
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-matrix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts a matrix.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ALIGN>: Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. <COL> chars).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample math-matrix 3 3 bccc
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-mode
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion If there is some selected text, it puts the text inside created math box.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-mode [on|<ARG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
\begin_inset Newline newline
\end_inset
"on": allow only entering of math mode from text mode.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Alejandro, 4 Jun 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-mutate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Mutates the type of math inset to the newly selected one.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-mutate <TYPE>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 23 May 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-number-line-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles numbering of the current formula line.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Must be in display formula mode.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-number-line-toggle
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-number-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles numbering/labeling of the current formula.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Must be in display formula mode.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-number-toggle
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Alejandro, 4 Jun 1996
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-size
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Changes arbitrarily the size used by math fonts inside a context.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Provides an interface to the LaTeX math mode font size commands.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-size <STYLE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <STYLE>:
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
displaystyle|
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
textstyle|
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
scriptstyle|
2014-02-10 08:31:46 +00:00
\backslash
2014-02-13 08:55:40 +00:00
scriptscriptstyle
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-space
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts space into math expression.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Use spacebar after entering this space to change type of space.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-space [<TYPE>] [<LEN>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
\begin_inset Newline newline
\end_inset
positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
\begin_inset Newline newline
\end_inset
custom space: hspace
\begin_inset Newline newline
\end_inset
"," used by default.
\begin_inset Newline newline
\end_inset
Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
\begin_inset Newline newline
\end_inset
<LEN>: length for custom spaces (hspace)
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-subscript
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Enters subscript expression in math expression.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-subscript
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vermeer, 12 Dec 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
math-superscript
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax math-superscript
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vermeer, 12 Dec 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
regexp-mode
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion If there is any selected text, then it is moved inside the created regexp inset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax regexp-mode [<ARG>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARG>: eventual argument (regular expression).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Tommaso, 4 Oct 2008
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
Buffer Fuctions (File and Window related)
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-activate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Activate the branch.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-activate <BRANCH>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
\begin_inset Newline newline
\end_inset
could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin rgh, 27 May 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-add
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Action Add a branch to the buffer's BranchList.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-add <BRANCH>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <BRANCH>: Name of the branch to add
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin spitz, 7 Jul 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-add-insert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Create new branch and directly put the branch inset into the document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-add-insert [<NAME>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: Branch name. If it is not specified, you will be asked.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sanda, 10 Jul 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-deactivate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action De-activate the branch.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-deactivate <BRANCH>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <BRANCH>: The branch to deactivate
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin rgh, 27 May 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-master-activate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Activate the branch in the master buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-master-activate <BRANCH>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
\begin_inset Newline newline
\end_inset
could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin spitz, 30 Sep 2012
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branch-master-deactivate
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action De-activate the branch in the master buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branch-master-deactivate <BRANCH>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <BRANCH>: The branch to deactivate
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin spitz, 30 Sep 2012
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
branches-rename
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Rename all branches of a given name in a document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax branches-rename <OLDNAME> <NEWNAME>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin spitz, 9 Jul 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-auto-save
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Saves the current buffer to a temporary file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-auto-save
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-child-open
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Loads the given child document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The current document is treated as a parent.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-child-open <FILE>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Ale, 28 May 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-chktex
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Runs chktex for the current document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-chktex
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 30 Oct 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-close
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Closes the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax buffer-close
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-close-all
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Closes all buffers.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax buffer-close-all
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-export
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Exports the current buffer (document) to the given format.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-export <FORMAT> [<DEST>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT> is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript.
\begin_inset Newline newline
\end_inset
In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM. <DEST> If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 29 Jul 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-export-as
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Opens a dialog for exporting the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-export-as [<FORMAT>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT> is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample buffer-export-as pdf2
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin tommaso, 6 Oct 2011
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-export-custom
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Exports the current buffer (document) from the given format using the given command on it.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-export-custom <FORMAT> <COMMAND>
2012-09-29 16:57:26 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
\begin_inset Newline newline
\end_inset
2012-09-29 16:57:26 +00:00
2014-02-13 08:55:40 +00:00
<COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 27 Mar 2004
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-forall
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Applies a command to all non-hidden buffers.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-forall <LFUN-COMMAND>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LFUN-COMMAND>: The command to be applied to the buffers.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Sample Close all Notes in buffers:
\begin_inset Newline newline
\end_inset
buffer-forall inset-forall Note inset-toggle close
\begin_inset Newline newline
\end_inset
Toggle change tracking on buffers:
\begin_inset Newline newline
\end_inset
buffer-forall changes-track
\begin_inset Newline newline
\end_inset
Toggle read-only for buffers:
\begin_inset Newline newline
\end_inset
buffer-forall buffer-toggle-read-only
\begin_inset Newline newline
\end_inset
Show statistics for individual buffers:
\begin_inset Newline newline
\end_inset
buffer-forall statistics
\begin_inset Newline newline
\end_inset
Activate the branch named "Solutions" in buffers:
\begin_inset Newline newline
\end_inset
buffer-forall branch-activate Solutions
\begin_inset Newline newline
\end_inset
Export buffers to PDF (pdflatex):
\begin_inset Newline newline
\end_inset
buffer-forall buffer-export pdf2
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Description
Origin skostysh, 20 Jul 2012
2014-02-13 08:55:40 +00:00
\end_layout
\begin_layout Subsection*
buffer-import
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Import a given file as a lyx document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-import <FORMAT> [<FILE>]
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 24 Jul 1998
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-language
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Set language of the current document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-language <LANG>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LANG>: language name. See lib/languages for list.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
buffer-move-next
\end_layout
\begin_layout Description
Action Moves the current tab one spot to the right.
\end_layout
\begin_layout Description
Syntax buffer-move-next
\end_layout
\begin_layout Description
Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
buffer-move-previous
\end_layout
\begin_layout Description
Action Moves the current tab one spot to the left.
\end_layout
\begin_layout Description
Syntax buffer-move-previous
\end_layout
\begin_layout Description
Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-new
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Creates a new buffer (that is, document) and switches to it.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Implicit path can be set in Preferences dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-new [<FILE>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: filename of created file with absolute path.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-new-template
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Creates a new buffer (that is, document) from a template.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-new-template [<FILE>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <FILE>: filename of created file with absolute path.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-next
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Switch to the next opened document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax buffer-next
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-params-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Apply the given settings to the current document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-params-apply [<ARGS>]
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin leeming, 30 Mar 2004
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-previous
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Switch to the previous opened document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-previous
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-reload
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reverts opened document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-reload
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 2 Feb 1997
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-save-as-default
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Save the current document settings as default.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax buffer-save-as-default [<ARGS>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin leeming, 30 Mar 2004
\end_layout
\begin_layout Subsection*
buffer-switch
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Display and switch to the given buffer.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-switch <BUFFER>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-toggle-compression
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles compression of the current document on/off.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-toggle-compression
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin bpeng, 27 Apr 2006
2013-02-03 15:36:45 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-toggle-read-only
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggle editing mode of the current document between read/write and read-only.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-toggle-read-only
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 27 May 1997
2014-02-10 08:31:46 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-update
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Exports the current document and put the result into the temporary directory.
2012-09-29 16:57:26 +00:00
\end_layout
2012-09-29 16:57:26 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-update [<FORMAT>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Dekel, 5 Aug 2000
2012-09-29 16:57:26 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-view
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Displays current buffer in chosen format.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-view [<FORMAT>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
\end_layout
\begin_layout Subsection*
buffer-view-cache
\end_layout
\begin_layout Description
Action Opens the file that was created from last preview of this buffer.
\end_layout
\begin_layout Description
Notion This LFUN is called by the "Show Output Anyway" button in the LaTeX Errors dialog. It can also be called by the user, which is useful if the document takes a long time to compile, and you just want to see the last previewed version.
\end_layout
\begin_layout Description
Syntax buffer-view-cache
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-write
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Saves the current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-write
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-write-all
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Save all changed documents.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-write-all
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin rgh, gpothier 6 Aug 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-write-as
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Rename and save current buffer.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-write-as <FILENAME>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-zoom-in
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Increases the zoom of the screen fonts.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-zoom-in [<ZOOM>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ZOOM>: The zoom in %, the default is 20.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 30 Mar 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-zoom-out
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Decreases the zoom of the screen fonts.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-zoom-out [<ZOOM>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <ZOOM>: The zoom in %, the default is 20.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin vfr, 30 Mar 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
build-program
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Generates the code (literate programming).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Latex file with extension
\backslash
literate_extension is generated. Then LyX invokes
\backslash
build_command (with a default of ``make'') to generate the code and
\backslash
build_error_filter to process the compilation error messages.
\begin_inset Newline newline
\end_inset
In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with:
\begin_inset Newline newline
\end_inset
\backslash
build_command "my_script my_arguments"
\begin_inset Newline newline
\end_inset
The
\backslash
build_error_filter differs from the
\backslash
literate_error_filter only in that the former will identify error messages from your compiler.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax build-program
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
file-open
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Open LyX document.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax file-open [<FILE>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: Filename to be opened.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
help-open
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Open the given help file according to the language setting.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax help-open <FILE>[.lyx]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILE>: any document from (/usr/share/)doc directory.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Jug, 27 Jun 1999
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
lyx-quit
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Terminates the current LyX instance.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax lyx-quit
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
master-buffer-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax master-buffer-update [<FORMAT>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Tommaso, 20 Sep 2007
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
master-buffer-view
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax master-buffer-view [<FORMAT>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Tommaso, 20 Sep 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
menu-open
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Opens the menu given by its name.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax menu-open <NAME>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
tab-group-close
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Close the current tab group.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax tab-group-close
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Abdel, 21 Feb 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
toolbar-toggle
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Action Toggles visibility of a given toolbar between on/off/auto.
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Notion Skipping "auto" when allowauto is false.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
Syntax toolbar-toggle <NAME> [allowauto]
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
Params <NAME>: standard|extra|table|math|mathmacrotemplate|
\begin_inset Newline newline
\end_inset
2014-02-10 08:31:46 +00:00
minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Origin Edwin, 21 May 2007
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
ui-toggle
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Action Various UI visibility-toggling actions.
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
Params statusbar : Toggle visibility of the statusbar.
\begin_inset Newline newline
\end_inset
2014-02-10 08:31:46 +00:00
menubar : Toggle visibility of the menubar.
\begin_inset Newline newline
\end_inset
2014-02-10 08:31:46 +00:00
scrollbar : Toggle visibility of the scrollbar.
\begin_inset Newline newline
\end_inset
frame : Toggle visibility of the frames around editing window.
\begin_inset Newline newline
\end_inset
2014-02-10 08:31:46 +00:00
fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
\end_layout
\begin_layout Description
2014-02-10 08:31:46 +00:00
Origin sanda, 9 Feb 2007
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
view-close
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Close the current document work area.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax view-close
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Tommaso, 15 Sep 2012
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
view-split
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Creates another split view of current buffer.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion All split views act in the same way independently.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax view-split <vertical|horizontal>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params horizontal : The work areas are laid out side by side.
\begin_inset Newline newline
\end_inset
vertical : The work areas laid out vertically.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Abdel, 20 Feb 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
window-close
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Closes the current LyX window.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax window-close
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Abdel, 23 Oct 2006
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
window-new
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Creates new empty LyX window.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Already opened documents from the previous window can be found under View menu.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax window-new [<GEOMETRY>]
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Abdel, 21 Oct 2006
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
2014-02-13 13:20:43 +00:00
System Functions (Preferences, LyX Server etc.)
2014-02-13 08:55:40 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
buffer-toggle-output-sync
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles including of resources for forward/reverse search of the given document.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax buffer-toggle-output-sync
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sanda, 25 May 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
call
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Executes a command defined in a .def file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The definitions are by default read from lib/commands/default.def.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
A .def file allows to define a command with
\backslash
define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE).
\backslash
def_file "FileName" allows to include another .def file.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax call <NAME>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <NAME>: Name of the command that must be called.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin broider, 2 Oct 2007
\end_layout
2014-02-10 08:31:46 +00:00
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
cancel
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Cancels sequence prepared by LFUN_META_PREFIX .
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax cancel
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
command-alternatives
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Runs the first listed command that is enabled.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax command-alternatives <CMDS>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <CMDS>: Sequence of commands separated by semicolons.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample command-alternatives completion-accept;cell-forward
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin rgh, 24 September 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
command-sequence
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Run more commands (LFUN and its parameters) in a sequence.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax command-sequence <CMDS>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <CMDS>: Sequence of commands separated by semicolons.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample command-sequence cut; ert-insert; self-insert
\backslash
; paste; self-insert {}; inset-toggle;
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Andre, 11 Nov 1999
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
cursor-follows-scrollbar-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax toggle-cursor-follows-scrollbar
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin ARRae, 2 Dec 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
debug-level-set
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Set debug output level.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax debug-level-set <LEVEL>
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 28 Dec 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
forward-search
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax forward-search
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 14 Apr 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
lyxrc-apply
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Apply the given settings to user preferences.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax lyxrc-apply <SETTINGS>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax. lyx::LyXRC::LyXRCTags has the list of possible commands.
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
message
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Shows message in statusbar (for script purposes).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax message <STRING>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 8 Apr 2001
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
meta-prefix
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Simulate halting Meta key (Alt key on PCs).
\end_layout
\begin_layout Description
2014-02-13 13:20:43 +00:00
Notion Used for buffer edition not for GUI control.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax meta-prefix
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
preferences-save
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Save user preferences.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax preferences-save
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 27 Nov 1999
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
reconfigure
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reconfigure the automatic settings.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax reconfigure
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Asger, 14 Feb 1997
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Subsection*
server-get-filename
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Returns path and file name of the currently edited document.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax server-get-filename
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
server-get-layout
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Returns the current layout (that is environment) name on the cursor position.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax server-get-layout
\end_layout
\begin_layout Subsection*
server-get-statistics
\end_layout
\begin_layout Description
Action Returns the statistics (number of words and characters) in the document or in the given selection.
\end_layout
\begin_layout Description
Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
\end_layout
\begin_layout Description
Syntax server-get-statistics [<TYPE>]
\end_layout
\begin_layout Description
Params <TYPE>: <words|chars|chars-space> The requested count; if not specified, the three values are returned, separated by a space.
\begin_inset Newline newline
\end_inset
words: count words.
\begin_inset Newline newline
\end_inset
chars: count characters.
\begin_inset Newline newline
\end_inset
chars-space: count characters and spaces.
\end_layout
\begin_layout Description
Origin brokenclock, Oct 10 2014
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
server-get-xy
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Returns the coordinates of cursor position in the editing area.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax server-get-xy
\end_layout
\begin_layout Subsection*
server-goto-file-row
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets the cursor position in LyX based on the row number of generated TeX file.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation. Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
\begin_inset Newline newline
\end_inset
If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file).
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
.ext: extensions will be automatically replaced by .lyx.
\begin_inset Newline newline
\end_inset
<ROW_NUMBER> The row number of the LaTeX file to which to go.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample server-goto-file-row /home/user/example.lyx 41
\begin_inset Newline newline
\end_inset
server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Edmar, 23 Dec 1998
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
server-notify
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sends notify message about the last key-sequence to client.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax server-notify
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
server-set-xy
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax server-set-xy <X> <Y>
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
set-color
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Set the given LyX color to the color defined by the X11 name given.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax set-color <LYX_NAME> <X11_NAME>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin SLior, 11 Jun 2000
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
statistics
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
Action Count the statistics (number of words and characters) in the document or in the given selection and display it in a dialog box.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax statistics
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-check-in
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Checks-in/commits the changes of the registered file to the repository.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion In RCS case this also unlocks the file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-check-in
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 1 Jul 1997
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-check-out
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Checks-out the document for edit (and locks it in some cases).
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-check-out
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 1 Jul 1997
2013-02-03 15:36:45 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-command
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Executes external command. This command is intended to support additional VCS commands.
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-command <FLAG> <PATH> <COMMAND>
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FLAG>: Flags for the command can be combined together.
\begin_inset Newline newline
\end_inset
U - dUmmy - no flags
\begin_inset Newline newline
\end_inset
D - Doc - need document loaded to proceed
\begin_inset Newline newline
\end_inset
I - dIrty - mark document dirty
\begin_inset Newline newline
\end_inset
R - Reload - ensure that the document is saved and reload it after command execution
\begin_inset Newline newline
\end_inset
M - Message - ask for input string (commit message)
\begin_inset Newline newline
\end_inset
<PATH>: path where to start. $$p will be replaced by the current document path.
\begin_inset Newline newline
\end_inset
<COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample vc-command DR $$p "svn up"
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin sanda, 13 Jan 2009
2013-02-03 15:36:45 +00:00
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-compare
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Compares two revisions of the same file under version control.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-compare [<REV1>] [<REV2>]
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
\begin_inset Newline newline
\end_inset
<REV1>: Older file.
\begin_inset Newline newline
\end_inset
<REV2>: Newer file. Used only if REV1 > 0.
\begin_inset Newline newline
\end_inset
If no parameter is given, interactive dialog will be shown.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Sample Compare current document against last commit
\begin_inset Newline newline
\end_inset
vc-compare 0
\begin_inset Newline newline
\end_inset
Compare current document against current revision - 5 commits
\begin_inset Newline newline
\end_inset
vc-compare -5
\begin_inset Newline newline
\end_inset
Compare revisions 120 and 155
\begin_inset Newline newline
\end_inset
vc-compare 120 155
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 12 Feb 2010
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-copy
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Copies the document to another name.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-copy <FILENAME>
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Params <FILENAME>: New name of the document.
\begin_inset Newline newline
\end_inset
A file dialog is opened if no filename is given.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin gb, 05 Feb 2013
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-locking-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Toggles the locking property of the edited file.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is currently implemented only for SVN.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-locking-toggle
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 25 Jun 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-register
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Register the document as an file inside version control system.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
\begin_inset Newline newline
\end_inset
See LyX Additional Features Manual (Version Control Chapter) for additional information.
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Syntax vc-register
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 1 Jul 1997
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-rename
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Renames the document to another name.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-rename <FILENAME>
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Params <FILENAME>: New name of the document.
2014-02-10 08:31:46 +00:00
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
A file dialog is opened if no filename is given.
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin gb, 05 Feb 2013
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-repo-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Update the local archive directory in which resides the current document with the remote repository.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-repo-update
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin sanda, 16 Oct 2009
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-revert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Reverts the document to the last check-in/commit in VCS.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-revert
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
vc-undo-last
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Undo last check-in.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion This is currently implemented only for RCS.
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax vc-check-out
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Description
Origin Lgb, 1 Jul 1997
\end_layout
2014-02-13 08:55:40 +00:00
\begin_layout Section
Hidden Functions (not listed for configuration)
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Subsection*
2014-02-13 08:55:40 +00:00
command-prefix
2014-02-10 08:31:46 +00:00
\end_layout
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Return the current key sequence and available options as a string.
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion No options are added if no current map exists.
\begin_inset Newline newline
\end_inset
2014-02-13 08:55:40 +00:00
This is probably usable only with connection to lyxserver.
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax command-prefix
\end_layout
\begin_layout Subsection*
self-insert
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Action Inserts the given string (accordingly to the correct keymap).
2013-02-03 15:36:45 +00:00
\end_layout
2013-02-03 15:36:45 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
2014-02-10 08:31:46 +00:00
\end_layout
2014-02-10 08:31:46 +00:00
\begin_layout Description
2014-02-13 08:55:40 +00:00
Syntax self-insert <STRING>
2013-02-03 15:36:45 +00:00
\end_layout
\end_body
\end_document