-#LyX 1.6.0rc2 created this file. For more info see http://www.lyx.org/
-\lyxformat 340
+# gen_lfuns.py generated this file. For more info see http://www.lyx.org/
+\lyxformat 509
\begin_document
\begin_header
-\textclass amsart
-\begin_modules
-theorems-ams
-\end_modules
+\save_transient_properties true
+\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
+\begin_local_layout
+Style Description
+LabelIndent MM
+LeftMargin MMMMMxx
+End
+\end_local_layout
\language english
+\language_package default
\inputencoding auto
-\font_roman default
-\font_sans default
-\font_typewriter default
+\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
-\font_tt_scale 100
-
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype 0
\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
-\use_amsmath 1
-\use_esint 1
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 0
+\use_package esint 1
+\use_package mathdots 0
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package stackrel 0
+\use_package stmaryrd 0
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type default
+\biblio_style plain
\use_bibtopic false
+\use_indices false
\paperorientation portrait
+\suppress_date false
+\justification true
+\use_refstyle 0
+\index Index
+\shortcut idx
+\color #008000
+\end_index
\leftmargin 2.5cm
\topmargin 2cm
\rightmargin 3cm
-\bottommargin 1cm
+\bottommargin 2.5cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
-\author ""
-\author ""
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict false
\end_header
\begin_body
+\begin_layout Title
+\SpecialChar LyX
+ Functions (LFUNs)
+\end_layout
+
+\begin_layout Author
+The \SpecialChar LyX
+ Team
+\end_layout
+
\begin_layout Section*
-LFUNs documentation automatically generated 25.09.2008.
+About this manual
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+This manual documents the
+\begin_inset Quotes eld
+\end_inset
+LyX Functions
+\begin_inset Quotes erd
+\end_inset
-\backslash
-thispagestyle{empty}
+ (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
+ bound to an LFUN.
\end_layout
+\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
+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
-
-\begin_inset VSpace 1cm
+remote-control
+\begin_inset Quotes erd
\end_inset
+ \SpecialChar LyX
+ .
+ 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
+.
\end_layout
-\begin_layout Subsection*
-LFUN_ACCENT_ACUTE
+\begin_layout Standard
+In the following, all LFUNs are listed, categorized by function.
\end_layout
-\begin_layout Description
-Action Adds an acute accent to the next character typed.
-
+\begin_layout Section
+Layout Functions (Font, Layout and Textclass related)
\end_layout
-\begin_layout Description
-Syntax accent-acute
+\begin_layout Subsection*
+drop-layouts-choice
\end_layout
-\begin_layout Subsection*
-LFUN_ACCENT_BREVE
+\begin_layout Description
+Action Displays list of layout choices.
\end_layout
\begin_layout Description
-Action Adds a breve accent to the next character typed.
-
+Notion This LFUN opens the dropbox allowing for choice of layout.
\end_layout
\begin_layout Description
-Syntax accent-breve
+Syntax drop-layouts-choice
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CARON
+environment-split
\end_layout
\begin_layout Description
-Action Adds a caron to the next character typed.
-
+Action Splits the current environment with a Separator.
\end_layout
\begin_layout Description
-Syntax accent-caron
-\end_layout
-
-\begin_layout Subsection*
-LFUN_ACCENT_CEDILLA
+Syntax environment-split [before|outer|previous]
\end_layout
\begin_layout Description
-Action Adds a cedilla to the next character typed.
-
+Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
+\begin_inset Newline newline
+\end_inset
+
+previous: If this is given, LyX will split the environment in the previous paragraph (if there is one).
+\begin_inset Newline newline
+\end_inset
+
+before: If this is given, the new environment will be appended rather than prepended.
\end_layout
\begin_layout Description
-Syntax accent-cedilla
+Origin spitz, 23 Dec 2012
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CIRCLE
+font-bold
\end_layout
\begin_layout Description
-Action Adds a circle accent to the next character typed.
-
+Action Toggles the bold font (selection-wise) using mathbf in math.
\end_layout
\begin_layout Description
-Syntax accent-circle
+Syntax font-bold
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_CIRCUMFLEX
+font-boldsymbol
\end_layout
\begin_layout Description
-Action Adds a circumflex to the next character typed.
-
+Action Toggles the bold font (selection-wise) using boldsymbol in math.
\end_layout
\begin_layout Description
-Syntax accent-circumflex
+Syntax font-boldsymbol
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_DOT
+font-crossout
\end_layout
\begin_layout Description
-Action Adds a dot accent to the next character typed.
-
+Action Toggles xout (cross-through) in the font (selection-wise).
+\end_layout
+
+\begin_layout Description
+Syntax font-crossout
\end_layout
\begin_layout Description
-Syntax accent-dot
+Origin uwestoehr, 4 April 2017
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_GRAVE
+font-default
\end_layout
\begin_layout Description
-Action Adds a grave accent to the next character typed.
-
+Action Reverts the settings of the font to the default values (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-grave
+Syntax font-default
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_HUNGARIAN_UMLAUT
+font-emph
\end_layout
\begin_layout Description
-Action Adds a Hungarian umlaut to the next character typed.
-
+Action Toggles the emphasis font style (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-grave
+Syntax font-emph
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_MACRON
+font-frak
\end_layout
\begin_layout Description
-Action Adds a macron to the next character typed.
-
+Action Toggles Fraktur family font (math-mode, selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-macron
+Syntax font-frak
+\end_layout
+
+\begin_layout Description
+Origin vermeer, 10 Jan 2002
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_OGONEK
+font-ital
\end_layout
\begin_layout Description
-Action Adds an ogonek accent to the next character typed.
-
+Action Toggles Italics font shape (math-mode, selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-ogonek
+Syntax font-ital
\end_layout
-\begin_layout Subsection*
-LFUN_ACCENT_TIE
+\begin_layout Description
+Origin vermeer, 10 Jan 2002
\end_layout
-\begin_layout Description
-Action Adds a tie over the next two character typed.
-
+\begin_layout Subsection*
+font-noun
\end_layout
\begin_layout Description
-Notion The following char will finish the tie.
-
+Action Toggles Noun text style font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-tie
+Syntax font-noun
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_TILDE
+font-roman
\end_layout
\begin_layout Description
-Action Adds a tilde over the next character typed.
-
+Action Toggles Roman family font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-tilde
+Syntax font-roman
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_UMLAUT
+font-sans
\end_layout
\begin_layout Description
-Action Adds an umlaut over the next character typed.
-
+Action Toggles Sans Serif family font (selection-wise).
\end_layout
\begin_layout Description
-Syntax accent-umlaut
+Syntax font-sans
\end_layout
\begin_layout Subsection*
-LFUN_ACCENT_UNDERBAR
+font-size
\end_layout
\begin_layout Description
-Action Adds a bar under the next character typed.
-
+Action Sets font size according to lyx format string.
+\end_layout
+
+\begin_layout Description
+Syntax font-size <SIZE>
\end_layout
\begin_layout Description
-Syntax accent-underbar
+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*
-LFUN_ACCENT_UNDERDOT
+font-state
\end_layout
\begin_layout Description
-Action Adds a dot under the next character typed.
-
+Action Returns the info about the current font.
\end_layout
\begin_layout Description
-Syntax accent-underdot
+Syntax font-state
\end_layout
\begin_layout Subsection*
-LFUN_CAPTION_INSERT
+font-strikeout
\end_layout
\begin_layout Description
-Action Inserts a caption inset.
-
+Action Toggles strikeout (strike-through) in the font (selection-wise).
\end_layout
\begin_layout Description
-Syntax caption-insert
+Syntax font-strikeout
\end_layout
\begin_layout Description
-Origin Lgb, 18 Jul 2000
+Origin sanda, 3 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_DATE_INSERT
+font-typewriter
\end_layout
\begin_layout Description
-Action Inserts the current date.
-
+Action Toggles the typewriter family font (selection-wise).
\end_layout
\begin_layout Description
-Syntax date-insert [<ARG>]
+Syntax font-typewriter
+\end_layout
+
+\begin_layout Subsection*
+font-underline
\end_layout
\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.
-
+Action Toggles underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Origin jdblair, 31 Jan 2000
+Syntax font-underline
\end_layout
\begin_layout Subsection*
-LFUN_FOOTNOTE_INSERT
+font-underunderline
\end_layout
\begin_layout Description
-Action Inserts a footnote inset.
-
+Action Toggles double underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Syntax footnote-insert
+Syntax font-underunderline
\end_layout
\begin_layout Description
-Origin Jug, 7 Mar 2000
+Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_ERT_INSERT
+font-underwave
\end_layout
\begin_layout Description
-Action Inserts an ERT inset.
-
+Action Toggles wavy underline in the font (selection-wise).
\end_layout
\begin_layout Description
-Syntax ert-insert
+Syntax font-underwave
\end_layout
\begin_layout Description
-Origin Jug, 18 Feb 2000
+Origin sanda, 5 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_FLOAT_INSERT
+layout
\end_layout
\begin_layout Description
-Action Inserts a float inset.
-
+Action Sets the layout (that is, environment) for the current paragraph.
\end_layout
\begin_layout Description
-Syntax float-insert <TYPE>
+Syntax layout <LAYOUT> [ignorenests]
\end_layout
\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
-
-\end_layout
+Params <LAYOUT>: the layout to use
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin Lgb, 27 Jun 2000
+ignorenests: If specified, nesting advices will be ignored.
\end_layout
\begin_layout Subsection*
-LFUN_FLOAT_WIDE_INSERT
+layout-module-add
\end_layout
\begin_layout Description
-Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
-
+Action Adds a module.
\end_layout
\begin_layout Description
-Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
-
+Notion Adds a module to the list of included modules for the current buffer.
\end_layout
\begin_layout Description
-Syntax float-wide-insert <TYPE>
+Syntax layout-module-add <MODULE>
\end_layout
\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
-
+Params <MODULE>: the module to be added
\end_layout
\begin_layout Description
-Origin Lgb, 31 Oct 2001
+Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
-LFUN_FLOAT_LIST_INSERT
+layout-modules-clear
\end_layout
\begin_layout Description
-Action Inserts the list of floats in the document.
-
+Action Clears the module list.
\end_layout
\begin_layout Description
-Syntax float-list-insert <TYPE>
+Notion Clears the list of included modules for the current buffer.
\end_layout
\begin_layout Description
-Params <TYPE>: type of float depends on the used textclass.
- Usually "algorithm", "table", "figure" parameters can be given.
-
+Syntax layout-modules-clear
\end_layout
\begin_layout Description
-Origin Lgb, 3 May 2001
+Origin rgh, 25 August 2007
\end_layout
\begin_layout Subsection*
-LFUN_WRAP_INSERT
+layout-paragraph
\end_layout
\begin_layout Description
-Action Inserts floats wrapped by the text around.
-
+Action Launches the paragraph settings dialog.
\end_layout
\begin_layout Description
-Syntax wrap-insert <TYPE>
+Syntax layout-paragraph
\end_layout
-\begin_layout Description
-Params <TYPE>: table|figure
+\begin_layout Subsection*
+layout-reload
\end_layout
\begin_layout Description
-Origin Dekel, 7 Apr 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_OPTIONAL_INSERT
+Action Reloads layout information.
\end_layout
\begin_layout Description
-Action Inserts an optional-argument (short title) inset.
-
+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.
\end_layout
\begin_layout Description
-Syntax optional-insert
+Syntax layout-reload
\end_layout
\begin_layout Description
-Origin vermeer, 12 Aug 2002
+Origin rgh, 3 September 2007
\end_layout
\begin_layout Subsection*
-LFUN_LINE_INSERT
+layout-tabular
\end_layout
\begin_layout Description
-Action Inserts a horizontal line.
-
+Action Launches the tabular settings dialog.
\end_layout
\begin_layout Description
-Syntax line-insert
+Syntax layout-tabular
\end_layout
\begin_layout Description
-Origin Andre, Oct 27 2003
+Origin Jug, 31 Jul 2000
\end_layout
\begin_layout Subsection*
-LFUN_NEWPAGE_INSERT
+layout-toggle
\end_layout
\begin_layout Description
-Action Inserts a new page.
-
+Action Toggles the layout (that is, environment) for the current paragraph.
\end_layout
\begin_layout Description
-Syntax newpage-insert <ARG>
+Notion Contrary to `layout', this function resets the current (or selection) layout to the standard layout it already has the correct layout. Useful for toolbar icons.
\end_layout
\begin_layout Description
-Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
-
+Syntax layout-toggle <LAYOUT> [ignorenests]
\end_layout
\begin_layout Description
-Origin uwestoehr, 24 Nov 2007
-\end_layout
+Params <LAYOUT>: the layout to toggle
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_MARGINALNOTE_INSERT
+ignorenests: If specified, nesting advices will be ignored.
\end_layout
\begin_layout Description
-Action Inserts a marginal note.
-
+Origin lasgouttes, 14 May 2018
\end_layout
-\begin_layout Description
-Syntax marginalnote-insert
+\begin_layout Subsection*
+screen-font-update
\end_layout
\begin_layout Description
-Origin Lgb, 26 Jun 2000
+Action Update fonts and its metrics.
\end_layout
-\begin_layout Subsection*
-LFUN_UNICODE_INSERT
+\begin_layout Description
+Notion Automatically called after zoom, dpi, font names, or norm change.
\end_layout
\begin_layout Description
-Action Inserts a single unicode character.
-
+Syntax screen-font-update
\end_layout
\begin_layout Description
-Syntax unicode-insert <CHAR>
+Origin ARRae, 13 Aug 2000
+\end_layout
+
+\begin_layout Subsection*
+textclass-apply
\end_layout
\begin_layout Description
-Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
-
+Action Sets the text class for the current buffer.
\end_layout
\begin_layout Description
-Sample unicode-insert 0x0100
+Syntax textclass-apply <TEXTCLASS>
\end_layout
\begin_layout Description
-Origin Lgb, 22 Oct 2006
+Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
\end_layout
\begin_layout Subsection*
-LFUN_LISTING_INSERT
+textclass-load
\end_layout
\begin_layout Description
-Action Inserts a new listings inset.
-
+Action Loads information for a textclass from disk.
\end_layout
\begin_layout Description
-Syntax listing-insert
+Syntax textclass-load <TEXTCLASS>
\end_layout
\begin_layout Description
-Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
+Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
\end_layout
\begin_layout Subsection*
-LFUN_QUOTE_INSERT
+textstyle-apply
\end_layout
\begin_layout Description
-Action Inserts quotes according to the type and quote-language preference.
-
+Action Apply last used text properties.
\end_layout
\begin_layout Description
-Action Currently English, Swedish, German, Polish, French, Danish quotes
- are distinguished.
-
+Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
\end_layout
\begin_layout Description
-Syntax quote-insert [<TYPE>]
+Syntax textstyle-apply [<NUM>]textstyle-apply
\end_layout
\begin_layout Description
-Params <TYPE>: 'single' for single quotes, otherwise double quotes will
- be used.
-
+Params <NUM>: number of the selection in the internal freefonts stack to be applied.
\end_layout
-\begin_layout Subsection*
-LFUN_INFO_INSERT
+\begin_layout Description
+Origin leeming, 12 Mar 2003
\end_layout
-\begin_layout Description
-Action Displays shortcuts, lyxrc, package and textclass availability and
- menu information in a non-editable boxed InsetText.
-
+\begin_layout Subsection*
+textstyle-update
\end_layout
\begin_layout Description
-Notion Apart from lfun arguments you can use the following method:
-\begin_inset Newline newline
-\end_inset
-
- 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.
-
+Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
\end_layout
\begin_layout Description
-Syntax info-insert <TYPE> <ARG>
+Syntax textstyle-update <FONT_INFO>
\end_layout
\begin_layout Description
-Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
+Params <FONT_INFO>: specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
\begin_inset Newline newline
\end_inset
- <ARG>: argument for a given type.
- Look into InsetInfo.h for detailed description.
-
+Use lyx -dbg action for exact syntax of text-style dialog parameters.
\end_layout
\begin_layout Description
-Origin bpeng, 7 Oct 2007
+Origin leeming, 12 Mar 2003
\end_layout
-\begin_layout Subsection*
-LFUN_BRANCH_INSERT
+\begin_layout Section
+Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)
\end_layout
-\begin_layout Description
-Action Inserts branch inset.
-
+\begin_layout Subsection*
+accent-acute
\end_layout
\begin_layout Description
-Syntax branch-insert <BRANCH-NAME>
+Action Adds an acute accent to the next character typed.
\end_layout
\begin_layout Description
-Origin vermeer, 17 Aug 2003
+Syntax accent-acute
\end_layout
\begin_layout Subsection*
-LFUN_BOX_INSERT
+accent-breve
\end_layout
\begin_layout Description
-Action Inserts Box inset.
-
+Action Adds a breve accent to the next character typed.
\end_layout
\begin_layout Description
-Syntax box-insert [<TYPE>]
+Syntax accent-breve
\end_layout
-\begin_layout Description
-Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
-
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+accent-caron
+\end_layout
- Framed is the default one.
-
+\begin_layout Description
+Action Adds a caron to the next character typed.
\end_layout
\begin_layout Description
-Origin vermeer, 7 Oct 2003
+Syntax accent-caron
\end_layout
\begin_layout Subsection*
-LFUN_FLEX_INSERT
+accent-cedilla
\end_layout
\begin_layout Description
-Action Inserts CharStyle, Custom inset or XML short element.
-
+Action Adds a cedilla to the next character typed.
\end_layout
\begin_layout Description
-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.
-
+Syntax accent-cedilla
\end_layout
-\begin_layout Description
-Syntax flex-insert <TYPE:Name>
+\begin_layout Subsection*
+accent-circle
\end_layout
\begin_layout Description
-Params TYPE: CharStyle|Custom|Element|Standard
-\begin_inset Newline newline
-\end_inset
-
- Identifies whether this is a Character Style, a Custom Inset or an XML
- Element, and which dynamical sub-menu this flex inset is in on the LyX
- menu tree.
- If Standard (currently unused): none of these.
- Name: This name must be defined either in your layout file or imported
- by some module.
- The definition is
-\begin_inset Newline newline
-\end_inset
-
- InsetLayout <TYPE:Name>
+Action Adds a circle accent to the next character typed.
\end_layout
\begin_layout Description
-Sample flex-insert CharStyle:Code
+Syntax accent-circle
\end_layout
\begin_layout Subsection*
-LFUN_SELF_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts the given string (accordingly to the correct keymap).
-
+accent-circumflex
\end_layout
\begin_layout Description
-Notion Automatically replace the currently selected text.
- Depends on lyxrc settings "auto_region_delete".
-
+Action Adds a circumflex to the next character typed.
\end_layout
\begin_layout Description
-Syntax self-insert <STRING>
+Syntax accent-circumflex
\end_layout
\begin_layout Subsection*
-LFUN_SPACE_INSERT
+accent-dot
\end_layout
\begin_layout Description
-Action Inserts one of horizontal space insets.
-
+Action Adds a dot accent to the next character typed.
\end_layout
\begin_layout Description
-Syntax space-insert <NAME> [<LEN>]
+Syntax accent-dot
\end_layout
-\begin_layout Description
-Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
-ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+accent-grave
+\end_layout
- <LEN>: length for custom spaces (hspace, hspace* for protected)
+\begin_layout Description
+Action Adds a grave accent to the next character typed.
\end_layout
\begin_layout Description
-Origin JSpitzm, 20 May 2003, Mar 17 2008
+Syntax accent-grave
\end_layout
\begin_layout Subsection*
-LFUN_HYPERLINK_INSERT
+accent-hungarian-umlaut
\end_layout
\begin_layout Description
-Action Inserts hyperlinks into the document (clickable in pdf output).
-
+Action Adds a Hungarian umlaut to the next character typed.
\end_layout
\begin_layout Description
-Notion Hyperlink target can be set via selection + hyperlink-insert function.
-
+Syntax accent-grave
+\end_layout
+
+\begin_layout Subsection*
+accent-macron
\end_layout
\begin_layout Description
-Syntax href-insert [<TARGET>]
+Action Adds a macron to the next character typed.
\end_layout
\begin_layout Description
-Origin CFO-G, 21 Nov 1997
+Syntax accent-macron
\end_layout
\begin_layout Subsection*
-LFUN_SPECIALCHAR_INSERT
+accent-ogonek
\end_layout
\begin_layout Description
-Action Inserts various characters into the document.
-
+Action Adds an ogonek accent to the next character typed.
\end_layout
\begin_layout Description
-Syntax specialchar-insert <CHAR>
+Syntax accent-ogonek
+\end_layout
+
+\begin_layout Subsection*
+accent-perispomeni
\end_layout
\begin_layout Description
-Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
-tence, menu-separator.
-
+Action Adds a perispomeni (Greek circumflex) over the next character typed.
\end_layout
\begin_layout Description
-Origin JSpitzm, 6 Dec 2007
+Syntax accent-perispomeni
\end_layout
\begin_layout Subsection*
-LFUN_TOC_INSERT
+accent-tie
\end_layout
\begin_layout Description
-Action Inserts table of contents.
-
+Action Adds a tie over the next two character typed.
\end_layout
\begin_layout Description
-Syntax toc-insert
+Notion The following char will finish the tie.
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 97
+Syntax accent-tie
\end_layout
\begin_layout Subsection*
-LFUN_APPENDIX
+accent-tilde
\end_layout
\begin_layout Description
-Action Start (or remove) Appendix on the given cursor position.
-
+Action Adds a tilde over the next character typed.
+\end_layout
+
+\begin_layout Description
+Syntax accent-tilde
+\end_layout
+
+\begin_layout Subsection*
+accent-umlaut
\end_layout
\begin_layout Description
-Syntax appendix
+Action Adds an umlaut over the next character typed.
\end_layout
\begin_layout Description
-Origin ettrich, 5 May 1998
+Syntax accent-umlaut
\end_layout
\begin_layout Subsection*
-LFUN_INDEX_INSERT
+accent-underbar
\end_layout
\begin_layout Description
-Action Inserts Index entry.
-
+Action Adds a bar under the next character typed.
\end_layout
\begin_layout Description
-Notion It automatically takes the word on the cursor position.
-
+Syntax accent-underbar
+\end_layout
+
+\begin_layout Subsection*
+accent-underdot
\end_layout
\begin_layout Description
-Syntax index-insert
+Action Adds a dot under the next character typed.
\end_layout
\begin_layout Description
-Origin leeming, 3 Aug 2000
+Syntax accent-underdot
\end_layout
\begin_layout Subsection*
-LFUN_INDEX_PRINT
+all-changes-accept
\end_layout
\begin_layout Description
-Action Inserts list of Index entries on a new page.
-
+Action Accepts all tracked changes in the document.
\end_layout
\begin_layout Description
-Syntax index-print
+Syntax all-changes-accept
\end_layout
\begin_layout Description
-Origin Lgb, 27 Feb 1997
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_NOMENCL_INSERT
+all-changes-reject
\end_layout
\begin_layout Description
-Action Inserts Nomenclature entry.
-
+Action Rejects all tracked changes in the document.
\end_layout
\begin_layout Description
-Notion It automatically takes the word on the cursor position if no symbol
- is given.
-
+Notion Reject does not work recursively; the user may have to repeat the operation.
\end_layout
\begin_layout Description
-Syntax nomencl-insert [<SYMBOL>]
+Syntax all-changes-reject
\end_layout
\begin_layout Description
-Origin Ugras, 4 Nov 2006
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_NOMENCLATURE_PRINT
+appendix
\end_layout
\begin_layout Description
-Action Inserts list of Nomenclature entries.
-
+Action Start (or remove) Appendix on the given cursor position.
\end_layout
\begin_layout Description
-Syntax nomenclature-print
+Syntax appendix
\end_layout
\begin_layout Description
-Origin Ugras, 4 Nov 2006
+Origin ettrich, 5 May 1998
\end_layout
\begin_layout Subsection*
-LFUN_NOTE_INSERT
-\end_layout
-
-\begin_layout Description
-Action Inserts Note on the current cursor postion, move selection inside
- the inset.
-
+argument-insert
\end_layout
\begin_layout Description
-Syntax note-insert [<TYPE>]
+Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
-Params <TYPE>: <Note|Greyedout|Comment> default: Note
-\end_layout
-
-\begin_layout Subsection*
-LFUN_NOTE_NEXT
+Syntax argument-insert <argument nr>
\end_layout
\begin_layout Description
-Action Moves the cursor to the begining of next Note inset.
-
+Params <argument nr>: see layout declarations
\end_layout
\begin_layout Description
-Syntax note-next
+Origin vermeer, 12 Aug 2002
\end_layout
\begin_layout Subsection*
-LFUN_NOTES_MUTATE
+bibtex-database-add
\end_layout
\begin_layout Description
-Action Changes all Note insets of a particular type (source) to a different
- type (target) fot the current document.
-
+Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
-Syntax notes-mutate <SOURCE> <TARGET>
+Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
\end_layout
\begin_layout Description
-Params <SOURCE/TARGET>: Note|Comment|Greyedout
+Syntax bibtex-database-add <DATABASE-NAME>
\end_layout
\begin_layout Description
-Origin sanda, 18 Jun 2008
+Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_NEWLINE_INSERT
+bibtex-database-del
\end_layout
\begin_layout Description
-Action Inserts a line break or new line.
-
+Action Adds database, which will be used for bibtex citations.
\end_layout
\begin_layout Description
-Syntax newline-insert [<ARG>]
+Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
\end_layout
\begin_layout Description
-Params <ARG>: <newline|linebreak> default: newline
+Syntax bibtex-database-del <DATABASE-NAME>
\end_layout
\begin_layout Description
-Origin JSpitzm, 25 Mar 2008
+Origin Ale, 30 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_ESCAPE
+bookmark-clear
\end_layout
\begin_layout Description
-Action Clears the selection.
- If no text is selected call LFUN_FINISHED_FORWARD.
-
+Action Clears the list of saved bookmarks.
\end_layout
\begin_layout Description
-Syntax escape
+Syntax bookmark-clear
\end_layout
\begin_layout Description
-Origin Lgb, 17 May 2001
+Origin bpeng, 31 October 2006
\end_layout
\begin_layout Subsection*
-LFUN_DOWN
+bookmark-goto
\end_layout
\begin_layout Description
-Action Moves the cursor one line in downward direction.
-
+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
-Syntax down
+Notion Bookmark 0 has a special purpose. It is automatically set
+\begin_inset Newline newline
+\end_inset
+
+1. to the paragraph you are currently editing
+\begin_inset Newline newline
+\end_inset
+
+2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
+\begin_inset Newline newline
+\end_inset
+
+3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
\end_layout
-\begin_layout Subsection*
-LFUN_UP
+\begin_layout Description
+Syntax bookmark-goto <NUMBER>
\end_layout
\begin_layout Description
-Action Moves the cursor one line in upward direction.
-
+Params <NUMBER>: the number of the bookmark to restore.
\end_layout
\begin_layout Description
-Syntax up
+Origin Dekel, 27 January 2001
\end_layout
\begin_layout Subsection*
-LFUN_DOWN_SELECT
+bookmark-save
\end_layout
\begin_layout Description
-Action Moves the cursor one line in downward direction adding the current
- position to the selection.
-
+Action Save a bookmark.
\end_layout
\begin_layout Description
-Syntax down-select
+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.
\end_layout
-\begin_layout Subsection*
-LFUN_UP_SELECT
+\begin_layout Description
+Syntax bookmark-save <NUMBER>
\end_layout
\begin_layout Description
-Action Moves the cursor one line in upward direction adding the current
- position to the selection.
-
+Params <NUMBER>: the number of the bookmark to save.
\end_layout
\begin_layout Description
-Syntax up-select
+Origin Dekel, 27 January 2001
\end_layout
\begin_layout Subsection*
-SCREEN_DOWN
+box-insert
\end_layout
\begin_layout Description
-Action Moves the cursor one page in downward direction.
-
+Action Inserts Box inset.
\end_layout
\begin_layout Description
-Syntax screen-down
-\end_layout
-
-\begin_layout Subsection*
-LFUN_SCREEN_UP
+Syntax box-insert [<TYPE>]
\end_layout
\begin_layout Description
-Action Moves the cursor one page in upward direction.
-
+Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
+\begin_inset Newline newline
+\end_inset
+
+Framed is the default one.
\end_layout
\begin_layout Description
-Syntax screen-up
+Origin vermeer, 7 Oct 2003
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_DOWN_SELECT
+branch-insert
\end_layout
\begin_layout Description
-Action Moves the cursor one screen in downward direction adding the current
- position to the selection.
-
+Action Inserts branch inset.
\end_layout
\begin_layout Description
-Syntax screen-down-select
+Syntax branch-insert <BRANCH-NAME>
+\end_layout
+
+\begin_layout Description
+Origin vermeer, 17 Aug 2003
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_UP_SELECT
+buffer-anonymize
+\end_layout
+
+\begin_layout Description
+Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla.
\end_layout
\begin_layout Description
-Action Moves the cursor one page in upward direction adding the current
- position to the selection.
-
+Syntax buffer-anonymize
\end_layout
\begin_layout Description
-Syntax screen-up-select
+Origin sanda, Feb 1 2018
\end_layout
\begin_layout Subsection*
-LFUN_SCROLL
+buffer-begin
\end_layout
\begin_layout Description
-Action Scroll the buffer view.
-
+Action Move the cursor to the beginning of the document.
\end_layout
\begin_layout Description
-Notion Only scrolls the screen up or down; does not move the cursor.
-
+Syntax buffer-begin
+\end_layout
+
+\begin_layout Subsection*
+buffer-begin-select
\end_layout
\begin_layout Description
-Syntax scroll <TYPE> <QUANTITY>
+Action Move the cursor to the beginning of the document adding the traversed text to the selection.
\end_layout
\begin_layout Description
-Params <TYPE>: line|page
-\begin_inset Newline newline
-\end_inset
+Syntax buffer-begin-select
+\end_layout
+
+\begin_layout Subsection*
+buffer-end
+\end_layout
- <QUANTITY>: up|down|<number>
+\begin_layout Description
+Action Move the cursor to the end of the document.
\end_layout
\begin_layout Description
-Origin Abdel, Dec 27 2007
+Syntax buffer-end
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_RECENTER
+buffer-end-select
\end_layout
\begin_layout Description
-Action Recenters the screen on the current cursor position.
-
+Action Move the cursor to the end of the document adding the traversed text to the selection.
\end_layout
\begin_layout Description
-Syntax screen-recenter
+Syntax buffer-end-select
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_BACKWARD
+caption-insert
\end_layout
\begin_layout Description
-Action Moves the cursor one position logically backwards.
-
+Action Inserts a caption inset.
\end_layout
\begin_layout Description
-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.
-
+Syntax caption-insert
\end_layout
\begin_layout Description
-Syntax char-backward
+Origin Lgb, 18 Jul 2000
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_BACKWARD_SELECT
+cell-backward
\end_layout
\begin_layout Description
-Action Moves the cursor one position logically backwards, adding traversed
- position to the selection.
-
+Action Moves the cursor to the previous cell inside the table.
\end_layout
\begin_layout Description
-Notion See also LFUN_CHAR_BACKWARD.
-
+Syntax cell-backward
\end_layout
\begin_layout Description
-Syntax char-backward-select
+Origin Jug, 22 May 2000
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_DELETE_BACKWARD
+cell-forward
\end_layout
\begin_layout Description
-Action Deletes one character in the backward direction (usually the "BackSpace"
- key).
-
+Action Moves the cursor to the next cell inside the table.
\end_layout
\begin_layout Description
-Syntax char-delete-backward
+Syntax cell-forward
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_DELETE_FORWARD
+cell-split
+\end_layout
+
+\begin_layout Description
+Action Splits cell and shifts right part to the next cell (inside the math grid).
\end_layout
\begin_layout Description
-Action Deletes one character in the backward direction (usually the "Delete"
- key).
-
+Syntax cell-split
\end_layout
\begin_layout Description
-Syntax char-delete-forward
+Origin Ale, 15 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_FORWARD
+change-accept
\end_layout
\begin_layout Description
-Action Moves the cursor one position logically forward.
-
+Action Accepts tracked change inside the selection.
\end_layout
\begin_layout Description
-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.
-
+Syntax change-accept
\end_layout
\begin_layout Description
-Syntax char-forward
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_FORWARD_SELECT
+change-next
\end_layout
\begin_layout Description
-Action Moves the cursor one position logically forward, adding traversed
- position to the selection.
-
+Action Moves the cursor to the position of the next change of the change tracking records.
\end_layout
\begin_layout Description
-Notion See also LFUN_CHAR_FORWARD.
-
+Syntax change-next
\end_layout
\begin_layout Description
-Syntax char-forward-select
+Origin schmitt, 4 Oct 2006
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_LEFT
+change-previous
\end_layout
\begin_layout Description
-Action Moves the cursor one position "to the left".
-
+Action Moves the cursor to the position of the previous change of the change tracking records.
\end_layout
\begin_layout Description
-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.
-
+Syntax change-previous
\end_layout
\begin_layout Description
-Syntax char-left
+Origin vfr, 4 Apr 2009
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_LEFT_SELECT
+change-reject
\end_layout
\begin_layout Description
-Action Moves the cursor one position "to the left", adding traversed position
- to the selection.
-
+Action Rejects tracked change inside the selection.
\end_layout
\begin_layout Description
-Notion See also LFUN_CHAR_LEFT for exact details of the movement.
-
+Syntax change-reject
\end_layout
\begin_layout Description
-Syntax char-left-select
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_RIGHT
+changes-merge
\end_layout
\begin_layout Description
-Action Moves the cursor one position "to the right".
-
+Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
\end_layout
\begin_layout Description
-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.
-
+Syntax changes-merge
\end_layout
\begin_layout Description
-Syntax char-right
+Origin Levon, 16 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_CHAR_RIGHT_SELECT
+changes-output
\end_layout
\begin_layout Description
-Action Moves the cursor one position "to the right", adding traversed position
- to the selection.
-
+Action Toggles showing of change tracking in typeset output.
\end_layout
\begin_layout Description
-Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
-
+Syntax changes-output
\end_layout
\begin_layout Description
-Syntax char-right-select
+Origin spitz, 21 Jan 2005
\end_layout
\begin_layout Subsection*
-LFUN_WORD_BACKWARD
+changes-track
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically previous beginning of a word.
-
+Action Toggles change tracking to on/off.
\end_layout
\begin_layout Description
-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.
-
+Syntax changes-track
\end_layout
\begin_layout Description
-Syntax word-backward
+Origin levon, 1 Oct 2002
\end_layout
\begin_layout Subsection*
-LFUN_WORD_BACKWARD_SELECT
+char-backward
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically previous beginning of a word, adding
- the logically traversed text to the selection.
-
+Action Moves the cursor one position logically backwards.
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_BACKWARD.
-
+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
-Syntax word-backward-select
+Syntax char-backward
\end_layout
\begin_layout Subsection*
-LFUN_WORD_DELETE_BACKWARD
+char-backward-select
+\end_layout
+
+\begin_layout Description
+Action Moves the cursor one position logically backwards, adding traversed position to the selection.
\end_layout
\begin_layout Description
-Action Deletes characters to the begining of the word (usually the "C+BackSpace"
- key).
-
+Notion See also LFUN_CHAR_BACKWARD.
\end_layout
\begin_layout Description
-Syntax word-delete-backward
+Syntax char-backward-select
\end_layout
\begin_layout Subsection*
-LFUN_WORD_DELETE_FORWARD
+char-delete-backward
\end_layout
\begin_layout Description
-Action Deletes characters to the end of the word (usually the "C+Delete"
- key).
-
+Action Deletes one character in the backward direction (usually the "BackSpace" key).
\end_layout
\begin_layout Description
-Syntax word-delete-forward
+Syntax char-delete-backward [force]
\end_layout
-\begin_layout Subsection*
-LFUN_WORD_FIND_FORWARD
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
\end_layout
-\begin_layout Description
-Action Search for a given string in forward direction.
-
+\begin_layout Subsection*
+char-delete-forward
\end_layout
\begin_layout Description
-Notion Case sensitive, match words.
- If no argument given, last search repeated.
-
+Action Deletes one character in the backward direction (usually the "Delete" key).
\end_layout
\begin_layout Description
-Syntax word-find-forward [<STRING>]
+Syntax char-delete-forward [force]
\end_layout
\begin_layout Description
-Origin Etienne, 16 Feb 1998
+Params force: Delete big insets, do not only select them.
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FIND_BACKWARD
+char-forward
\end_layout
\begin_layout Description
-Action Search for a given string in backward direction.
-
+Action Moves the cursor one position logically forward.
\end_layout
\begin_layout Description
-Notion Case sensitive, match words.
- If no argument given, last search repeated.
-
+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
\begin_layout Description
-Syntax word-find-backward [<STRING>]
+Syntax char-forward
+\end_layout
+
+\begin_layout Subsection*
+char-forward-select
\end_layout
\begin_layout Description
-Origin Etienne, 20 Feb 1998
+Action Moves the cursor one position logically forward, adding traversed position to the selection.
\end_layout
-\begin_layout Subsection*
-LFUN_WORD_FIND
+\begin_layout Description
+Notion See also LFUN_CHAR_FORWARD.
\end_layout
\begin_layout Description
-Action Search for next occurence of a string.
-
+Syntax char-forward-select
+\end_layout
+
+\begin_layout Subsection*
+char-left
\end_layout
\begin_layout Description
-Syntax word-find [<DATA>]
+Action Moves the cursor one position "to the left".
\end_layout
\begin_layout Description
-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).
-
+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.
\end_layout
\begin_layout Description
-Origin Andre, Jan 7 2004
+Syntax char-left
\end_layout
\begin_layout Subsection*
-LFUN_WORD_REPLACE
+char-left-select
\end_layout
\begin_layout Description
-Action Replace a string in the document.
-
+Action Moves the cursor one position "to the left", adding traversed position to the selection.
\end_layout
\begin_layout Description
-Syntax word-replace [<DATA>]
+Notion See also LFUN_CHAR_LEFT for exact details of the movement.
\end_layout
\begin_layout Description
-Params <DATA>: data is of the form "<search>
-\begin_inset Newline newline
-\end_inset
+Syntax char-left-select
+\end_layout
- <replace>
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+char-right
+\end_layout
+
+\begin_layout Description
+Action Moves the cursor one position "to the right".
+\end_layout
- <casesensitive> <matchword> <all> <forward>"
+\begin_layout Description
+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
-Origin Andre, Jan 7 2004
+Syntax char-right
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FORWARD
+char-right-select
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically next beginning of a word.
-
+Action Moves the cursor one position "to the right", adding traversed position to the selection.
\end_layout
\begin_layout Description
-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.
-
+Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
\end_layout
\begin_layout Description
-Syntax word-forward
+Syntax char-right-select
\end_layout
\begin_layout Subsection*
-LFUN_WORD_FORWARD_SELECT
+chars-transpose
\end_layout
\begin_layout Description
-Action Moves the cursor to the logically next beginning of a word, adding
- the logically traversed text to the selection.
-
+Action Transposes the character at the cursor with the one before it.
\end_layout
\begin_layout Description
-Notion See also LFUN_WORD_FORWARD.
-
+Syntax chars-transpose
\end_layout
\begin_layout Description
-Syntax word-forward-select
+Origin Lgb, 25 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_WORD_LEFT
+citation-insert
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the left".
-
+Action Inserts citation from loaded citation database.
\end_layout
\begin_layout Description
-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.
-
+Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
\end_layout
\begin_layout Description
-Syntax word-left
+Params <KEY>: Citation (shortcut listed in available citations).
+\begin_inset Newline newline
+\end_inset
+
+<TEXT_BEFORE>: text which should appear before citation.
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Origin AAS, 97-02-23
\end_layout
\begin_layout Subsection*
-LFUN_WORD_LEFT_SELECT
+clipboard-paste
\end_layout
\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the left", adding
- *logically* traversed text to the selection.
-
+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
-Notion See also LFUN_WORD_LEFT for exact details of the movement.
-
+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
-Syntax word-left-select
+Syntax clipboard-paste [<ARG>]
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
-\begin_layout Subsection*
-LFUN_WORD_RIGHT
+\begin_layout Description
+Origin Georg, 10 Jul 2006
\end_layout
-\begin_layout Description
-Action Moves the cursor to the next beginning of a word "on the right".
-
+\begin_layout Subsection*
+clipboard-paste-simple
\end_layout
\begin_layout Description
-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.
-
+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
-Syntax word-right
+Syntax clipboard-paste-simple [<ARG>]
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Subsection*
-LFUN_WORD_RIGHT_SELECT
+command-execute
\end_layout
\begin_layout Description
-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
-Notion See also LFUN_WORD_RIGHT for exact details of the movement.
-
+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
-Syntax word-right-select
+Notion Usually bound to M-x shortcut.
\end_layout
\begin_layout Description
-Origin dov, 28 Oct 2007
+Syntax command-execute
\end_layout
\begin_layout Subsection*
-LFUN_WORD_SELECT
+complete
\end_layout
\begin_layout Description
-Action Puts the word where the cursor stands into the selection.
-
+Action Try to complete the word or command at the cursor position.
\end_layout
\begin_layout Description
-Syntax word-select
+Syntax complete
\end_layout
\begin_layout Description
-Origin Andre, 11 Sep 2002
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_CAPITALIZE
+completion-accept
+\end_layout
+
+\begin_layout Description
+Action Accept suggested completion.
\end_layout
\begin_layout Description
-Action Capitalizes the words in the selection (i.e.
- the first letters) or the letter on the cursor position.
-
+Syntax completion-accept
\end_layout
\begin_layout Description
-Syntax word-capitalize
+Origin sanda, Sep 08 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_UPCASE
+completion-cancel
+\end_layout
+
+\begin_layout Description
+Action Try to cancel completion, either the popup or the inline completion.
\end_layout
\begin_layout Description
-Action Change the words in the selection or from the cursor position to
- the end of word to the upper case.
-
+Syntax completion-cancel
\end_layout
\begin_layout Description
-Syntax word-upcase
+Origin sts, Sep 07 2008
\end_layout
\begin_layout Subsection*
-LFUN_WORD_LOWCASE
+completion-inline
+\end_layout
+
+\begin_layout Description
+Action Show the inline completion at the cursor position.
\end_layout
\begin_layout Description
-Action Change the words in the selection or from the cursor position to
- the end of word to the lower case.
-
+Syntax completion-inline
\end_layout
\begin_layout Description
-Syntax word-lowcase
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_THESAURUS_ENTRY
+completion-popup
\end_layout
\begin_layout Description
-Action Look up thesaurus entries with respect to the word under the cursor.
-
+Action Show the completion popup at the cursor position.
\end_layout
\begin_layout Description
-Syntax thesaurus-entry
+Syntax completion-popup
\end_layout
\begin_layout Description
-Origin Levon, 20 Jul 2001
+Origin sts, Feb 19 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_BEGIN
+copy
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the document.
-
+Action Copies the current selection to the clipboard.
\end_layout
\begin_layout Description
-Syntax buffer-begin
+Syntax copy
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_BEGIN_SELECT
+cut
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the document adding the traversed
- text to the selection.
-
+Action Cuts to the clipboard.
\end_layout
\begin_layout Description
-Syntax buffer-begin-select
+Syntax cut
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_END
+depth-decrement
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the document.
-
+Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
\end_layout
\begin_layout Description
-Syntax buffer-end
+Syntax depth-decrement
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_END_SELECT
+depth-increment
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the document adding the traversed text
- to the selection.
-
+Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
\end_layout
\begin_layout Description
-Syntax buffer-end-select
+Syntax depth-increment
\end_layout
\begin_layout Subsection*
-LFUN_LINE_BEGIN
+dialog-disconnect-inset
\end_layout
\begin_layout Description
-Action Move the cursor to the begining of the (screen) line.
-
+Action Closes opened connection to opened inset.
\end_layout
\begin_layout Description
-Syntax line-begin
-\end_layout
-
-\begin_layout Subsection*
-LFUN_LINE_BEGIN_SELECT
+Notion Connection is used for apply functions.
\end_layout
\begin_layout Description
-Action Move the cursor to the beginning of the (screen) line adding the
- traversed text to the selection.
-
+Syntax dialog-disconnect-inset <INSET-NAME>
\end_layout
\begin_layout Description
-Syntax line-begin-select
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_LINE_END
+dialog-hide
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the (screen) line.
-
+Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Syntax line-end
-\end_layout
-
-\begin_layout Subsection*
-LFUN_LINE_END_SELECT
+Syntax dialog-hide <NAME>
\end_layout
\begin_layout Description
-Action Move the cursor to the end of the (screen) line adding the traversed
- text to the selection.
-
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Syntax line-end-select
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_LINE_DELETE
+dialog-show
\end_layout
\begin_layout Description
-Action Deletes the letters to the end of the (screen) line or deletes the
- selection.
-
+Action Shows hidden dialog or creates new one for a given function/inset settings etc.
\end_layout
\begin_layout Description
-Syntax line-delete-forward
-\end_layout
-
-\begin_layout Subsection*
-LFUN_COPY
+Syntax dialog-show <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Action Copies to the clipboard the last edit.
-
+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
\begin_layout Description
-Syntax copy
+Origin leeming, 17 Jun 2003
\end_layout
\begin_layout Subsection*
-LFUN_CUT
+dialog-show-new-inset
\end_layout
\begin_layout Description
-Action Cuts to the clipboard.
-
+Action Shows hidden dialog or create new one for a given inset settings etc.
\end_layout
\begin_layout Description
-Syntax cut
-\end_layout
-
-\begin_layout Subsection*
-LFUN_PASTE
+Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
\end_layout
\begin_layout Description
-Action Pastes material from the active clipboard.
-
+Syntax dialog-show-new-inset <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Syntax paste [<TYPE>]
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Params <TYPE>: pdf|png|jpeg|linkback
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_CLIPBOARD_PASTE
+dialog-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggles dialog between showed/hidden state.
\end_layout
\begin_layout Description
-Action Pastes text from the active clipboard.
-
+Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
\end_layout
\begin_layout Description
-Syntax clipboard-paste [<ARG>]
+Syntax dialog-toggle <NAME> [<DATA>]
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
- "Join lines".
-
+Params See LFUN_DIALOG_SHOW .
\end_layout
\begin_layout Description
-Origin baum, 10 Jul 2006
+Origin spitz, 30 Apr 2007
\end_layout
\begin_layout Subsection*
-LFUN_PRIMARY_SELECTION_PASTE
+dialog-update
\end_layout
\begin_layout Description
-Action Pastes the currently text selected text.
-
+Action Updates the dialog values from the inset/paragraph/document.
\end_layout
\begin_layout Description
-Notion Primary selection mechanism is linux-only thing.
-
+Syntax dialog-update <NAME>
\end_layout
\begin_layout Description
-Syntax primary-selection-paste [<ARG>]
+Params <NAME>: paragraph|prefs|<INSET>
+\begin_inset Newline newline
+\end_inset
+
+<INSET>: inset name
\end_layout
\begin_layout Description
-Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
- "Join lines".
-
+Origin leeming, 25 Feb 2003
\end_layout
\begin_layout Subsection*
-LFUN_UNDO
+down
\end_layout
\begin_layout Description
-Action Undoes the last edit.
-
+Action Moves the cursor one line in downward direction.
\end_layout
\begin_layout Description
-Syntax undo
+Syntax down
\end_layout
\begin_layout Subsection*
-LFUN_REDO
+down-select
\end_layout
\begin_layout Description
-Action Redoes the last thing undone.
-
+Action Moves the cursor one line in downward direction adding the current position to the selection.
\end_layout
\begin_layout Description
-Syntax redo
+Syntax down-select
\end_layout
\begin_layout Subsection*
-LFUN_REPEAT
+ert-insert
\end_layout
\begin_layout Description
-Action Repeat the given command.
-
+Action Inserts an ERT inset.
\end_layout
\begin_layout Description
-Syntax repeat <COUNT> <LFUN-COMMAND>
+Syntax ert-insert
\end_layout
\begin_layout Description
-Origin Andre, , 27 Oct 2003
+Origin Jug, 18 Feb 2000
\end_layout
\begin_layout Subsection*
-LFUN_CHARS_TRANSPOSE
+escape
\end_layout
\begin_layout Description
-Action Transposes the character at the cursor with the one before it.
-
+Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
\end_layout
\begin_layout Description
-Syntax chars-transpose
+Syntax escape
\end_layout
\begin_layout Description
-Origin Lgb, 25 Apr 2001
+Origin Lgb, 17 May 2001
\end_layout
\begin_layout Subsection*
-LFUN_DEPTH_DECREMENT
+export-cancel
\end_layout
\begin_layout Description
-Action Decrease the nesting depth of the (selected) paragraph(s) inside
- lists.
-
+Action Cancel background export process.
\end_layout
\begin_layout Description
-Syntax depth-decrement
+Syntax export-cancel
+\end_layout
+
+\begin_layout Description
+Origin rgh, 10 December 2017
\end_layout
\begin_layout Subsection*
-LFUN_DEPTH_INCREMENT
+file-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts another LyX file.
\end_layout
\begin_layout Description
-Action Increase the nesting depth of the (selected) paragraph(s) inside
- lists.
-
+Syntax file-insert [<FILE>] [ignorelang]
\end_layout
\begin_layout Description
-Syntax depth-increment
+Params <FILE>: Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used).
\end_layout
\begin_layout Subsection*
-LFUN_FONT_BOLD
+file-insert-plaintext
\end_layout
\begin_layout Description
-Action Toggles the bold font (selection-wise) using mathbf in math.
-
+Action Inserts plain text file.
\end_layout
\begin_layout Description
-Syntax font-bold
+Syntax file-insert-plaintext [<FILE>]
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_BOLDSYMBOL
+\begin_layout Description
+Params <FILE>: Filename to be inserted.
\end_layout
\begin_layout Description
-Action Toggles the bold font (selection-wise) using boldsymbol in math.
-
+Origin CFO-G, 19 Nov 1997
+\end_layout
+
+\begin_layout Subsection*
+file-insert-plaintext-para
\end_layout
\begin_layout Description
-Syntax font-boldsymbol
+Action Inserts plain text file as paragraph (i.e. join lines).
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_TYPEWRITER
+\begin_layout Description
+Syntax file-insert-plaintext-para [<FILE>]
\end_layout
\begin_layout Description
-Action Toggles the typewriter family font (selection-wise).
-
+Params <FILE>: Filename to be inserted.
\end_layout
\begin_layout Description
-Syntax font-typewriter
+Origin Levon, 14 Feb 2001
\end_layout
\begin_layout Subsection*
-LFUN_FONT_UNDERLINE
+flex-insert
\end_layout
\begin_layout Description
-Action Toggles underline in the font (selection-wise).
-
+Action Inserts CharStyle, Custom inset or XML short element.
\end_layout
\begin_layout Description
-Syntax font-underline
+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
-\begin_layout Subsection*
-LFUN_FONT_EMPH
+\begin_layout Description
+Syntax flex-insert Name
\end_layout
\begin_layout Description
-Action Toggles the emphasis font style (selection-wise).
-
+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
-Syntax font-emph
+Sample flex-insert Code
\end_layout
\begin_layout Subsection*
-LFUN_FONT_NOUN
+float-insert
\end_layout
\begin_layout Description
-Action Toggles Noun text style font (selection-wise).
-
+Action Inserts a float inset.
\end_layout
\begin_layout Description
-Syntax font-noun
-\end_layout
-
-\begin_layout Subsection*
-LFUN_FONT_ROMAN
+Syntax float-insert <TYPE>
\end_layout
\begin_layout Description
-Action Toggles Roman family font (selection-wise).
-
+Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Syntax font-roman
+Origin Lgb, 27 Jun 2000
\end_layout
\begin_layout Subsection*
-LFUN_FONT_SANS
+float-list-insert
\end_layout
\begin_layout Description
-Action Toggles Sans Serif family font (selection-wise).
-
+Action Inserts the list of floats in the document.
\end_layout
\begin_layout Description
-Syntax font-sans
+Syntax float-list-insert <TYPE>
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_FRAK
+\begin_layout Description
+Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Action Toggles Fraktur family font (math-mode, selection-wise).
-
+Origin Lgb, 3 May 2001
\end_layout
-\begin_layout Description
-Syntax font-frak
+\begin_layout Subsection*
+float-wide-insert
\end_layout
\begin_layout Description
-Origin vermeer, 10 Jan 2002
+Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
\end_layout
-\begin_layout Subsection*
-LFUN_FONT_ITAL
+\begin_layout Description
+Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
\end_layout
\begin_layout Description
-Action Toggles Italics font shape (math-mode, selection-wise).
-
+Syntax float-wide-insert <TYPE>
\end_layout
\begin_layout Description
-Syntax font-ital
+Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
\end_layout
\begin_layout Description
-Origin vermeer, 10 Jan 2002
+Origin Lgb, 31 Oct 2001
\end_layout
\begin_layout Subsection*
-LFUN_FONT_DEFAULT
+footnote-insert
\end_layout
\begin_layout Description
-Action Reverts the settings of the font to the default values (selection-wise).
-
+Action Inserts a footnote inset.
+\end_layout
+
+\begin_layout Description
+Syntax footnote-insert
\end_layout
\begin_layout Description
-Syntax font-default
+Origin Jug, 7 Mar 2000
\end_layout
\begin_layout Subsection*
-LFUN_FONT_SIZE
+graphics-reload
\end_layout
\begin_layout Description
-Action Sets font size according to lyx format string.
-
+Action Reloads the image if necessary.
\end_layout
\begin_layout Description
-Syntax font-size <SIZE>
+Syntax graphics-reload
\end_layout
\begin_layout Description
-Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
-\begin_inset Newline newline
-\end_inset
-
- largest|huge|giant|increase|decrease|default
+Origin vfr, 10 Aug 2009
\end_layout
\begin_layout Subsection*
-LFUN_TEXTSTYLE_APPLY
+graphics-set-group
\end_layout
\begin_layout Description
-Action Toggle user-defined (=last-time used) text style.
-
+Action Set the group for the graphics inset on the cursor position.
\end_layout
\begin_layout Description
-Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
- trigerred when using Text Style dialog.
-
+Syntax graphics-set-group [<GROUP>]
\end_layout
\begin_layout Description
-Syntax textstyle-apply
+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
\begin_layout Description
-Origin leeming, 12 Mar 2003
+Origin sanda, 6 May 2008
\end_layout
\begin_layout Subsection*
-LFUN_TEXTSTYLE_UPDATE
+graphics-unify
\end_layout
\begin_layout Description
-Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
-LY.
-
+Action Set the same group for all graphics insets in the marked block.
\end_layout
\begin_layout Description
-Syntax textstyle-update <FONT_INFO>
+Syntax graphics-unify [<GROUP>]
\end_layout
\begin_layout Description
-Params <FONT_INFO>: specifies font atributes, e.g.
- family, series, shape, size, emph, noun, underbar, number, color, language,
- toggleall.
-
-\begin_inset Newline newline
-\end_inset
-
- Use lyx -dbg action for exact syntax of text-style dialog parameters.
-
+Params <GROUP>: Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used.
\end_layout
\begin_layout Description
-Origin leeming, 12 Mar 2003
+Origin sanda, 7 Feb 2018
\end_layout
\begin_layout Subsection*
-LFUN_SCREEN_FONT_UPDATE
+href-insert
\end_layout
\begin_layout Description
-Action Update fonts and its metrics.
-
+Action Inserts hyperlinks into the document (clickable in pdf output).
\end_layout
\begin_layout Description
-Notion Automatically called after zoom, dpi, font names, or norm change.
-
+Notion Hyperlink target can be set via selection + hyperlink-insert function.
\end_layout
\begin_layout Description
-Syntax screen-font-update
+Syntax href-insert [<TARGET>]
\end_layout
\begin_layout Description
-Origin ARRae, 13 Aug 2000
+Origin CFO-G, 21 Nov 1997
\end_layout
\begin_layout Subsection*
-LFUN_FONT_STATE
+in-ipa
\end_layout
\begin_layout Description
-Action Returns the info about the current font.
-
+Action Only active in IPA inset.
+\end_layout
+
+\begin_layout Description
+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
+Syntax in-ipa
\end_layout
\begin_layout Description
-Syntax font-state
+Origin spitz, 20 May 2012
\end_layout
\begin_layout Subsection*
-LFUN_CITATION_INSERT
+index-insert
\end_layout
\begin_layout Description
-Action Inserts citation from loaded citation database.
-
+Action Inserts Index entry.
\end_layout
\begin_layout Description
-Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
+Notion It automatically takes the word on the cursor position.
\end_layout
\begin_layout Description
-Params <KEY>: Citation (shortcut listed in available citations).
-
-\begin_inset Newline newline
-\end_inset
+Syntax index-insert [<TYPE:Name>]
+\end_layout
- <TEXT_BEFORE>: text which should appear before citation.
-
+\begin_layout Description
+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
-Origin AAS, 97-02-23
+Origin leeming, 3 Aug 2000
\end_layout
\begin_layout Subsection*
-LFUN_BIBTEX_DATABASE_ADD
+index-print
\end_layout
\begin_layout Description
-Action Adds database, which will be used for bibtex citations.
-
+Action Inserts list of Index entries on a new page.
\end_layout
\begin_layout Description
-Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
- bibliography) found from the cursor postion.
-
+Syntax index-print [<TYPE:Name>]
\end_layout
\begin_layout Description
-Syntax bibtex-database-add <DATABASE-NAME>
+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
-Origin Ale, 30 May 1997
+Origin Lgb, 27 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_BIBTEX_DATABASE_DEL
+info-insert
\end_layout
\begin_layout Description
-Action Adds database, which will be used for bibtex citations.
-
+Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
\end_layout
\begin_layout Description
-Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
-X bibliography) found from the cursor postion.
-
+Notion Apart from lfun arguments you can use the following method:
+\begin_inset Newline newline
+\end_inset
+
+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
+Syntax info-insert <TYPE> <ARG>
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs
+\begin_inset Newline newline
+\end_inset
+
+<ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
+\begin_inset Newline newline
+\end_inset
+
+date: current date (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+moddate: date of last modification (saving) (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+fixdate: a static date (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+time: current time (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+modtime: time of last modification (saving) (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+fixtime: a static time (formatted and localized)
+\begin_inset Newline newline
+\end_inset
+
+shortcut[s]: name of lfun (e.g math-insert
+\backslash
+alpha)
+\begin_inset Newline newline
+\end_inset
+
+lyxrc: name of rc_entry (e.g. bind_file)
+\begin_inset Newline newline
+\end_inset
+
+lyxinfo: "version" - used version of LyX
+\begin_inset Newline newline
+\end_inset
+
+package: name of latex package (e.g. listings)
+\begin_inset Newline newline
+\end_inset
+
+textclass: name of textclass (e.g. article)
+\begin_inset Newline newline
+\end_inset
+
+menu: name of lfun used in menu
+\begin_inset Newline newline
+\end_inset
+
+l7n: localizable string.
+\begin_inset Newline newline
+\end_inset
+
+icon: icon of lfun used in toolbar or direct icon name
+\begin_inset Newline newline
+\end_inset
+
+buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time"
+\end_layout
+
+\begin_layout Description
+Sample command-sequence info-insert buffer path; info-insert buffer name
+\end_layout
+
+\begin_layout Description
+Origin bpeng, 7 Oct 2007
+\end_layout
+
+\begin_layout Subsection*
+inset-apply
+\end_layout
+
+\begin_layout Description
+Action Apply data for an inset.
+\end_layout
+
+\begin_layout Description
+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
+Syntax inset-apply <ARGS>
+\end_layout
+
+\begin_layout Description
+Params See LFUN_INSET_INSERT .
+\end_layout
+
+\begin_layout Subsection*
+inset-begin
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
+\end_layout
+
+\begin_layout Description
+Syntax inset-begin
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-begin-select
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
+\end_layout
+
+\begin_layout Description
+Syntax inset-begin-select
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-copy-as
+\end_layout
+
+\begin_layout Description
+Action Copies the inset to the clipboard as a certain type.
+\end_layout
+
+\begin_layout Description
+Notion Currently used only for InsetInfo where its content is copied as a text.
+\end_layout
+
+\begin_layout Description
+Syntax inset-copy-as
+\end_layout
+
+\begin_layout Description
+Origin vfr, 18 Apr 2010
+\end_layout
+
+\begin_layout Subsection*
+inset-dissolve
+\end_layout
+
+\begin_layout Description
+Action Dissolve the current inset into text.
+\end_layout
+
+\begin_layout Description
+Syntax inset-dissolve [<INSET>]
+\end_layout
+
+\begin_layout Description
+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_ .
+\end_layout
+
+\begin_layout Description
+Origin JSpitz, 7 Aug 2006
+\end_layout
+
+\begin_layout Subsection*
+inset-edit
+\end_layout
+
+\begin_layout Description
+Action Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished.
+\end_layout
+
+\begin_layout Description
+Syntax inset-edit [<INSET_PARAMS>]
+\end_layout
+
+\begin_layout Description
+Params <INSET_PARAMS>: Parameters for the inset.
+\begin_inset Newline newline
+\end_inset
+
+Currently only the filename will be considered.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 27 Apr 2006
+\end_layout
+
+\begin_layout Subsection*
+inset-end
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset.
+\end_layout
+
+\begin_layout Description
+Syntax inset-end
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-end-edit
+\end_layout
+
+\begin_layout Description
+Action End editing the inset at cursor with an external application. This replaces the inset contents with the contents of the temporary file, deletes the file and unlocks the inset.
+\end_layout
+
+\begin_layout Description
+Syntax inset-end-edit
+\end_layout
+
+\begin_layout Description
+Origin gb, 11 Oct 2015
+\end_layout
+
+\begin_layout Subsection*
+inset-end-select
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection).
+\end_layout
+
+\begin_layout Description
+Syntax inset-end-select
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 16 Mar 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-forall
+\end_layout
+
+\begin_layout Description
+Action Apply the given commands on insets of a given name.
+\end_layout
+
+\begin_layout Description
+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.
+\end_layout
+
+\begin_layout Description
+Syntax inset-forall <NAME> <LFUN-COMMAND>
+\begin_inset Newline newline
+\end_inset
+
+<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
+Sample Remove all index insets:
+\begin_inset Newline newline
+\end_inset
+
+inset-forall Index char-delete-forward force
+\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
+Origin lasgouttes, 27 Nov 2009
+\end_layout
+
+\begin_layout Subsection*
+inset-insert
+\end_layout
+
+\begin_layout Description
+Action Insert new inset (type given by the parameters).
+\end_layout
+
+\begin_layout Description
+Syntax inset-insert <INSET> <ARGS>
+\end_layout
+
+\begin_layout Description
+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
+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
+
+\begin_layout Subsection*
+inset-modify
+\end_layout
+
+\begin_layout Description
+Action Modify some properties of an inset.
+\end_layout
+
+\begin_layout Description
+Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
+\end_layout
+
+\begin_layout Description
+Syntax inset-modify <INSET> <ARGS>
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype <TYPE>
+\end_layout
+
+\begin_layout Description
+Sample Change a Note inset into a Comment inset:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+Change a Box into an Ovalbox:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype Ovalbox
+\begin_inset Newline newline
+\end_inset
+
+Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype els
+\begin_inset Newline newline
+\end_inset
+
+Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype e..
+\begin_inset Newline newline
+\end_inset
+
+
+\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).
+\end_layout
+
+\begin_layout Description
+Syntax inset-select-all
+\end_layout
+
+\begin_layout Description
+Origin vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
+\end_layout
+
+\begin_layout Subsection*
+inset-settings
+\end_layout
+
+\begin_layout Description
+Action Open the inset's properties dialog.
+\end_layout
+
+\begin_layout Description
+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.
+\end_layout
+
+\begin_layout Description
+Syntax inset-settings <INSET>
+\end_layout
+
+\begin_layout Description
+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*
+inset-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
+\end_layout
+
+\begin_layout Description
+Syntax inset-toggle [<ARG>]
+\end_layout
+
+\begin_layout Description
+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.
+\end_layout
+
+\begin_layout Description
+Origin lasgouttes, 19 Jul 2001
+\end_layout
+
+\begin_layout Subsection*
+ipa-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts an IPA inset.
+\end_layout
+
+\begin_layout Description
+Syntax ipa-insert
+\end_layout
+
+\begin_layout Description
+Origin spitz, 05 Mar 2012
+\end_layout
+
+\begin_layout Subsection*
+ipamacro-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts special IPA macros into the document.
+\end_layout
+
+\begin_layout Description
+Syntax ipamacro-insert <CHAR>
+\end_layout
+
+\begin_layout Description
+Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 22 Aug 2012
+\end_layout
+
+\begin_layout Subsection*
+keymap-off
+\end_layout
+
+\begin_layout Description
+Action Turn off the loaded keyboard map.
+\end_layout
+
+\begin_layout Description
+Syntax keymap-off
+\end_layout
+
+\begin_layout Subsection*
+keymap-primary
+\end_layout
+
+\begin_layout Description
+Action Turn on the primary keyboard map.
+\end_layout
+
+\begin_layout Description
+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
+
+\begin_layout Description
+Syntax keymap-primary
+\end_layout
+
+\begin_layout Subsection*
+keymap-secondary
+\end_layout
+
+\begin_layout Description
+Action Turn on the secondary keyboard map.
+\end_layout
+
+\begin_layout Description
+Syntax keymap-secondary
+\end_layout
+
+\begin_layout Subsection*
+keymap-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggles keyboard maps (first/second/off).
+\end_layout
+
+\begin_layout Description
+Syntax keymap-toggle
+\end_layout
+
+\begin_layout Description
+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*
+label-goto
+\end_layout
+
+\begin_layout Description
+Action Goto a label.
+\end_layout
+
+\begin_layout Description
+Syntax label-goto [<LABEL>]
+\end_layout
+
+\begin_layout Description
+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
+
+\begin_layout Description
+Origin Ale, 6 Aug 1997
+\end_layout
+
+\begin_layout Subsection*
+label-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts label to text or displayed formula.
+\end_layout
+
+\begin_layout Description
+Syntax label-insert [<LABEL>]
+\end_layout
+
+\begin_layout Description
+Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
+\end_layout
+
+\begin_layout Subsection*
+label-insert-as-reference
+\end_layout
+
+\begin_layout Description
+Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
+\end_layout
+
+\begin_layout Description
+Syntax label-insert-as-reference
+\end_layout
+
+\begin_layout Description
+Origin vfr, 7 Apr 2009
+\end_layout
+
+\begin_layout Subsection*
+language
+\end_layout
+
+\begin_layout Description
+Action Set language from the current cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax language <LANG> [set]
+\end_layout
+
+\begin_layout Description
+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
+Origin Dekel, 2 Mar 2000
+\end_layout
+
+\begin_layout Subsection*
+line-begin
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the beginning of the (screen) line.
+\end_layout
+
+\begin_layout Description
+Syntax line-begin
+\end_layout
+
+\begin_layout Subsection*
+line-begin-select
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
+\end_layout
+
+\begin_layout Description
+Syntax line-begin-select
+\end_layout
+
+\begin_layout Subsection*
+line-delete-forward
+\end_layout
+
+\begin_layout Description
+Action Deletes the letters to the end of the (screen) line or deletes the selection.
+\end_layout
+
+\begin_layout Description
+Syntax line-delete-forward
+\end_layout
+
+\begin_layout Subsection*
+line-end
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the (screen) line.
+\end_layout
+
+\begin_layout Description
+Syntax line-end
+\end_layout
+
+\begin_layout Subsection*
+line-end-select
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
+\end_layout
+
+\begin_layout Description
+Syntax line-end-select
+\end_layout
+
+\begin_layout Subsection*
+listing-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a new listings inset.
+\end_layout
+
+\begin_layout Description
+Syntax listing-insert
+\end_layout
+
+\begin_layout Description
+Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
+\end_layout
+
+\begin_layout Subsection*
+marginalnote-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a marginal note.
+\end_layout
+
+\begin_layout Description
+Syntax marginalnote-insert
+\end_layout
+
+\begin_layout Description
+Origin Lgb, 26 Jun 2000
+\end_layout
+
+\begin_layout Subsection*
+mark-off
+\end_layout
+
+\begin_layout Description
+Action Disable selecting of text-region.
+\end_layout
+
+\begin_layout Description
+Syntax mark-off
+\end_layout
+
+\begin_layout Subsection*
+mark-on
+\end_layout
+
+\begin_layout Description
+Action Enable selecting of text-region.
+\end_layout
+
+\begin_layout Description
+Notion After enabling you can simply move arrow keys to get selected region.
+\end_layout
+
+\begin_layout Description
+Syntax mark-on
+\end_layout
+
+\begin_layout Subsection*
+mark-toggle
+\end_layout
+
+\begin_layout Description
+Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
+\end_layout
+
+\begin_layout Description
+Syntax mark-toggle
+\end_layout
+
+\begin_layout Description
+Origin Andre, May 5 2006
+\end_layout
+
+\begin_layout Subsection*
+newline-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a line break or new line.
+\end_layout
+
+\begin_layout Description
+Syntax newline-insert [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: <newline|linebreak> default: newline
+\end_layout
+
+\begin_layout Description
+Origin spitz, 25 Mar 2008
+\end_layout
+
+\begin_layout Subsection*
+newpage-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a new page.
+\end_layout
+
+\begin_layout Description
+Syntax newpage-insert <ARG>
+\end_layout
+
+\begin_layout Description
+Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 24 Nov 2007
+\end_layout
+
+\begin_layout Subsection*
+nomencl-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts Nomenclature entry.
+\end_layout
+
+\begin_layout Description
+Notion It automatically takes the word on the cursor position if no symbol is given.
+\end_layout
+
+\begin_layout Description
+Syntax nomencl-insert [<SYMBOL>]
+\end_layout
+
+\begin_layout Description
+Origin Ugras, 4 Nov 2006
+\end_layout
+
+\begin_layout Subsection*
+nomencl-print
+\end_layout
+
+\begin_layout Description
+Action Inserts list of Nomenclature entries.
+\end_layout
+
+\begin_layout Description
+Syntax nomenclature-print
+\end_layout
+
+\begin_layout Description
+Origin Ugras, 4 Nov 2006
+\end_layout
+
+\begin_layout Subsection*
+note-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts Note on the current cursor position, move selection inside the inset.
+\end_layout
+
+\begin_layout Description
+Syntax note-insert [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: <Note|Greyedout|Comment> default: Note
+\end_layout
+
+\begin_layout Subsection*
+note-next
+\end_layout
+
+\begin_layout Description
+Action Moves the cursor to the beginning of next Note inset.
+\end_layout
+
+\begin_layout Description
+Syntax note-next
+\end_layout
+
+\begin_layout Subsection*
+outline-down
+\end_layout
+
+\begin_layout Description
+Action Move the current group in the downward direction in the structure of the document.
+\end_layout
+
+\begin_layout Description
+Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
+\end_layout
+
+\begin_layout Description
+Syntax outline-down
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+outline-in
+\end_layout
+
+\begin_layout Description
+Action Moves the current group in the downward direction in the hierarchy of the document structure.
+\end_layout
+
+\begin_layout Description
+Notion Part -> Chapter -> Section -> etc.
+\end_layout
+
+\begin_layout Description
+Syntax outline-in
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+outline-out
+\end_layout
+
+\begin_layout Description
+Action Moves the current group in the upward direction in the hierarchy of the document structure.
+\end_layout
+
+\begin_layout Description
+Notion Part <- Chapter <- Section <- etc.
+\end_layout
+
+\begin_layout Description
+Syntax outline-out
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+outline-up
+\end_layout
+
+\begin_layout Description
+Action Move the current group in the upward direction in the structure of the document.
+\end_layout
+
+\begin_layout Description
+Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
+\end_layout
+
+\begin_layout Description
+Syntax outline-up
+\end_layout
+
+\begin_layout Description
+Origin Vermeer, 23 Mar 2006
+\end_layout
+
+\begin_layout Subsection*
+paragraph-break
+\end_layout
+
+\begin_layout Description
+Action Breaks the current paragraph at the current location.
+\end_layout
+
+\begin_layout Description
+Notion Removes the selection.
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-break [<LAYOUT>] [ignoresep]
+\end_layout
+
+\begin_layout Description
+Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
+\begin_inset Newline newline
+\end_inset
+
+ignoresep: Do not account for paragraph separators while breaking.
+\end_layout
+
+\begin_layout Subsection*
+paragraph-down
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-down
+\end_layout
+
+\begin_layout Description
+Origin Asger, 1 Oct 1996
+\end_layout
+
+\begin_layout Subsection*
+paragraph-down-select
+\end_layout
+
+\begin_layout Description
+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
+Syntax paragraph-down-select
+\end_layout
+
+\begin_layout Description
+Origin Asger, 1 Oct 1996
+\end_layout
+
+\begin_layout Subsection*
+paragraph-goto
+\end_layout
+
+\begin_layout Description
+Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
+\end_layout
+
+\begin_layout Description
+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). Both ids must belong to the same buffer.
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
+\end_layout
+
+\begin_layout Description
+Params <PAR_ID>: paragraph id
+\begin_inset Newline newline
+\end_inset
+
+<POS_IN_PAR>: desired position within the paragraph
+\end_layout
+
+\begin_layout Description
+Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
+\end_layout
+
+\begin_layout Subsection*
+paragraph-move-down
+\end_layout
+
+\begin_layout Description
+Action Moves the current paragraph downwards in the document.
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-move-down
+\end_layout
+
+\begin_layout Description
+Origin Edwin, 8 Apr 2006
+\end_layout
+
+\begin_layout Subsection*
+paragraph-move-up
+\end_layout
+
+\begin_layout Description
+Action Moves the current paragraph upwards in the document.
+\end_layout
+
+\begin_layout Description
+Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-move-up
+\end_layout
+
+\begin_layout Description
+Origin Edwin, 8 Apr 2006
+\end_layout
+
+\begin_layout Subsection*
+paragraph-params
+\end_layout
+
+\begin_layout Description
+Action Change paragraph settings.
+\end_layout
+
+\begin_layout Description
+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
+Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
+\end_layout
+
+\begin_layout Description
+Params <INDENT>:
+\backslash
+noindent|
+\backslash
+indent|
+\backslash
+indent-toggle|
+\backslash
+leftindent LENGTH
+\begin_inset Newline newline
+\end_inset
+
+<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
+Origin rgh, Aug 15 2007
+\end_layout
+
+\begin_layout Subsection*
+paragraph-params-apply
+\end_layout
+
+\begin_layout Description
+Action Change paragraph settings.
+\end_layout
+
+\begin_layout Description
+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
+Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
+\end_layout
+
+\begin_layout Description
+Params For parameters see LFUN_PARAGRAPH_PARAMS
+\end_layout
+
+\begin_layout Description
+Origin leeming, 30 Mar 2004
+\end_layout
+
+\begin_layout Subsection*
+paragraph-select
+\end_layout
+
+\begin_layout Description
+Action Move cursor to beginning of current paragraph and select to the end in downward direction
+\end_layout
+
+\begin_layout Description
+Notion This function is by default bound to triple mouse click
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-select
+\end_layout
+
+\begin_layout Description
+Origin Kornel, 16 Apr 2019
+\end_layout
+
+\begin_layout Subsection*
+paragraph-up
+\end_layout
+
+\begin_layout Description
+Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
+\end_layout
+
+\begin_layout Description
+Syntax paragraph-up
+\end_layout
+
+\begin_layout Description
+Origin Asger, 1 Oct 1996
+\end_layout
+
+\begin_layout Subsection*
+paragraph-up-select
+\end_layout
+
+\begin_layout Description
+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
+Syntax paragraph-up-select
+\end_layout
+
+\begin_layout Description
+Origin Asger, 1 Oct 1996
+\end_layout
+
+\begin_layout Subsection*
+paste
+\end_layout
+
+\begin_layout Description
+Action Pastes material (text or picture) from the active clipboard.
+\end_layout
+
+\begin_layout Description
+Syntax paste [<TYPE>|<NUM>]
+\end_layout
+
+\begin_layout Description
+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*
+phantom-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts phantom on the current cursor position, move selection inside the inset.
+\end_layout
+
+\begin_layout Description
+Syntax phantom-insert [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 30 Jan 2009
+\end_layout
+
+\begin_layout Subsection*
+preview-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts a new preview inset.
+\end_layout
+
+\begin_layout Description
+Syntax preview-insert
+\end_layout
+
+\begin_layout Description
+Origin vfr, 28 Mar 2010
+\end_layout
+
+\begin_layout Subsection*
+primary-selection-paste
+\end_layout
+
+\begin_layout Description
+Action Pastes the currently selected text.
+\end_layout
+
+\begin_layout Description
+Notion Primary selection mechanism is linux-only thing.
+\end_layout
+
+\begin_layout Description
+Syntax primary-selection-paste [<ARG>]
+\end_layout
+
+\begin_layout Description
+Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
+\end_layout
+
+\begin_layout Subsection*
+quote-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts quotes according to the type and quote-language preference.
+\end_layout
+
+\begin_layout Description
+Notion Currently 15 different quote styles are distinguished (see params).
\end_layout
-\begin_layout Description
-Syntax bibtex-database-del <DATABASE-NAME>
-\end_layout
+\begin_layout Description
+Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
+\end_layout
+
+\begin_layout Description
+Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
+\begin_inset Newline newline
+\end_inset
+
+<SIDE>: 'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
+\begin_inset Newline newline
+\end_inset
+
+<STYLE>: 'british' for `British' quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'danish' for >>Danish<< quote style (with >inner quotation<)
+\begin_inset Newline newline
+\end_inset
+
+'english' for ``English'' quote style (with `inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'french' for <<french>> quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin Ale, 30 May 1997
-\end_layout
+'german' for ,,German`` quote style (with ,inner quotation`)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_LAYOUT
-\end_layout
+'plain' for "Plain" quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Sets the layout (that is, environment) for the current paragraph.
-
-\end_layout
+'polish' for ,,Polish'' quote style (with ,inner quotation')
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax layout <LAYOUT>
-\end_layout
+'swedish' for ''Swedish'' quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <LAYOUT>: the layout to use
+'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
+\begin_inset Newline newline
+\end_inset
+
+'swiss' for <<Swiss>> quote style (with <inner quotation>)
+\begin_inset Newline newline
+\end_inset
+
+'russian' for <<Russian>> quote style (with ,,inner quotation``)
+\begin_inset Newline newline
+\end_inset
+
+'dynamic' for Dynamic quotation marks which inherit the global document style
+\begin_inset Newline newline
+\end_inset
+
+If no quote style is specified, the document-wide will be used.
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_PARAGRAPH
+redo
\end_layout
\begin_layout Description
-Action Launches the paragraph settings dialog.
-
+Action Redoes the last thing undone.
\end_layout
\begin_layout Description
-Syntax layout-paragraph
+Syntax redo
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_TABULAR
+reference-next
\end_layout
\begin_layout Description
-Action Launches the tabular settings dialog.
-
+Action Go to the next label or cross-reference.
\end_layout
\begin_layout Description
-Syntax layout-tabular
+Syntax reference-next
\end_layout
\begin_layout Description
-Origin Jug, 31 Jul 2000
+Origin Dekel, 14 Jan 2001
\end_layout
\begin_layout Subsection*
-LFUN_DROP_LAYOUTS_CHOICE
+repeat
\end_layout
\begin_layout Description
-Action Displays list of layout choices.
-
+Action Repeat the given command.
\end_layout
\begin_layout Description
-Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
- allowing for choice of layout.
-
+Notion fails when the repeat count is greater than 10000.
\end_layout
\begin_layout Description
-Syntax drop-layouts-choice
+Syntax repeat <COUNT> <LFUN-COMMAND>
+\end_layout
+
+\begin_layout Description
+Origin Andre, 27 Oct 2003
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_MODULES_CLEAR
+screen-down
\end_layout
\begin_layout Description
-Action Clears the module list.
-
+Action Moves the cursor one page in downward direction.
\end_layout
\begin_layout Description
-Notion Clears the list of included modules for the current buffer.
-
+Syntax screen-down
+\end_layout
+
+\begin_layout Subsection*
+screen-down-select
\end_layout
\begin_layout Description
-Syntax layout-modules-clear
+Action Moves the cursor one screen in downward direction adding the current position to the selection.
\end_layout
\begin_layout Description
-Origin rgh, 25 August 2007
+Syntax screen-down-select
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_MODULE_ADD
+screen-recenter
\end_layout
\begin_layout Description
-Action Adds a module.
-
+Action Recenters the screen on the current cursor position.
\end_layout
\begin_layout Description
-Notion Adds a module to the list of included modules for the current buffer.
-
+Syntax screen-recenter
+\end_layout
+
+\begin_layout Subsection*
+screen-show-cursor
\end_layout
\begin_layout Description
-Syntax layout-module-add <MODULE>
+Action Repositions the screen such that the cursor is visible.
\end_layout
\begin_layout Description
-Params <MODULE>: the module to be added
+Syntax screen-show-cursor
\end_layout
\begin_layout Description
-Origin rgh, 25 August 2007
+Origin vfr, 25 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_LAYOUT_RELOAD
+screen-up
\end_layout
\begin_layout Description
-Action Reloads layout information.
-
+Action Moves the cursor one page in upward direction.
\end_layout
\begin_layout Description
-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.
-
+Syntax screen-up
+\end_layout
+
+\begin_layout Subsection*
+screen-up-select
\end_layout
\begin_layout Description
-Syntax layout-reload
+Action Moves the cursor one page in upward direction adding the current position to the selection.
\end_layout
\begin_layout Description
-Origin rgh, 3 September 2007
+Syntax screen-up-select
\end_layout
\begin_layout Subsection*
-LFUN_TEXTCLASS_APPLY
+script-insert
\end_layout
\begin_layout Description
-Action Sets the text class for the current buffer.
-
+Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
-Syntax textclass-apply <TEXTCLASS>
+Syntax script-insert <TYPE>
\end_layout
\begin_layout Description
-Params <TEXTCLASS>: the textclass to set.
- Note that this must be the filename, minus the ".layout" extension.
-
+Params <TYPE>: subscript|superscript
\end_layout
-\begin_layout Subsection*
-LFUN_TEXTCLASS_LOAD
+\begin_layout Description
+Origin Georg, 23 Nov 2010
\end_layout
-\begin_layout Description
-Action Loads information for a textclass from disk.
-
+\begin_layout Subsection*
+scroll
\end_layout
\begin_layout Description
-Syntax textclass-load <TEXTCLASS>
+Action Scroll the buffer view.
\end_layout
\begin_layout Description
-Params <TEXTCLASS>: the textclass to load.
- Note that this must be the filename, minus the ".layout" extension.
-
+Notion Only scrolls the screen up or down; does not move the cursor.
\end_layout
-\begin_layout Subsection*
-LFUN_MARK_OFF
+\begin_layout Description
+Syntax scroll <TYPE> <QUANTITY>
\end_layout
\begin_layout Description
-Action Disable selecting of text-region.
-
+Params <TYPE>: line|page
+\begin_inset Newline newline
+\end_inset
+
+<QUANTITY>: up|down|<number>
\end_layout
\begin_layout Description
-Syntax mark-off
+Origin Abdel, Dec 27 2007
\end_layout
\begin_layout Subsection*
-LFUN_MARK_ON
+section-select
\end_layout
\begin_layout Description
-Action Enable selecting of text-region.
-
+Action Select the whole section.
\end_layout
\begin_layout Description
-Notion After enabling you can simply move arrow keys to get selected region.
-
+Notion The cursor should be in a section heading before calling this lfun.
\end_layout
\begin_layout Description
-Syntax mark-on
+Syntax section-select
+\end_layout
+
+\begin_layout Description
+Origin vfr, 05 May 2009
\end_layout
\begin_layout Subsection*
-LFUN_MARK_TOGGLE
+selection-paste
\end_layout
\begin_layout Description
-Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
-
+Action Pastes the internal selection text in permanent selection.
\end_layout
\begin_layout Description
-Syntax mark-toggle
+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
-Origin Andre, May 5 2006
+Syntax selection-paste
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_DELIM
+\begin_layout Description
+Origin lasgouttes, 14 Jan 2009
\end_layout
-\begin_layout Description
-Action Inserts math delimiters (e.g.
- parentheses, brackets) enclosing expression.
-
+\begin_layout Subsection*
+separator-insert
\end_layout
\begin_layout Description
-Syntax math-delim [<LEFT>] [<RIGHT>]
+Action Inserts an environment separator or latex paragraph break.
\end_layout
\begin_layout Description
-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.
-
+Syntax separator-insert [<ARG>]
\end_layout
\begin_layout Description
-Sample math-delim { rangle
+Params <ARG>: <plain|parbreak|latexpar> default: plain
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Origin ef, 2 May 2014
\end_layout
\begin_layout Subsection*
-LFUN_MATH_BIGDELIM
+space-insert
\end_layout
\begin_layout Description
-Action Inserts math fixed size delimiters (e.g.
- parentheses, brackets) enclosing expression.
-
+Action Inserts one of horizontal space insets.
\end_layout
\begin_layout Description
-Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
+Syntax space-insert <NAME> [<LEN>]
\end_layout
\begin_layout Description
-Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
+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
- <L/RDELIM>: TeX code for delimiter.
- See Delimiter dialog for delimiters to be used.
-
-\end_layout
+Only in math mode: med and thick.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Sample math-bigdelim "Bigl" "Downarrow" "Bigr" "}"
+<LEN>: length for custom spaces (hspace, hspace* for protected)
\end_layout
\begin_layout Description
-Origin Enrico & Georg, 7 May 2006
+Origin spitz, 20 May 2003, Mar 17 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_DISPLAY
+specialchar-insert
\end_layout
\begin_layout Description
-Action Creates a new displayed equation in text mode.
- Toggles inlined/display formula in math mode.
-
+Action Inserts various characters into the document.
\end_layout
\begin_layout Description
-Syntax math-display [<ARG>]
+Syntax specialchar-insert <CHAR>
\end_layout
\begin_layout Description
-Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
- new equation from the text mode.
-
+Params <CHAR>: hyphenation, allowbreak, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Origin spitz, 6 Dec 2007
\end_layout
\begin_layout Subsection*
-LFUN_MATH_INSERT
+spelling-add
\end_layout
\begin_layout Description
-Action Inserts math objects and symbols.
-
+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
-Syntax math-insert <ARG>
+Syntax spelling-add [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
-Params <ARG>: Symbol or LaTeX code to be inserted.
-
+Params <WORD>: word to add <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin spitz, 18 Jan 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SUBSCRIPT
+spelling-continuously
\end_layout
\begin_layout Description
-Action Enters subscript expression in math expression.
-
+Action Toggle continuous spell checking.
\end_layout
\begin_layout Description
-Syntax math-subscript
+Syntax spelling-continuously
\end_layout
\begin_layout Description
-Origin vermeer, 12 Dec 2001
+Origin vfr, 24 March 2013
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SUPERSCRIPT
+spelling-ignore
\end_layout
\begin_layout Description
-Action Enters subscript expression in math expression.
-
+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
+Syntax spelling-ignore [<WORD>] [<LANG>]
\end_layout
\begin_layout Description
-Syntax math-superscript
+Params <WORD>: word to ignore <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
-Origin vermeer, 12 Dec 2001
+Origin spitz, 18 Jan 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_LIMITS
+spelling-remove
\end_layout
\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.
-
+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
-Notion Put the cursor before the symbol with the limits and then invoke
- math-limits.
-
+Syntax spelling-remove [<STRING>] [<LANG>]
\end_layout
\begin_layout Description
-Syntax math-limits [<STATE>]
+Params <WORD>: word to remove <LANG>: language name (see file languages)
\end_layout
\begin_layout Description
-Params <STATE>: limits|nolimits
+Origin SWitt, 28 July 2010
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO
+tab-delete
\end_layout
\begin_layout Description
-Action Inserts a math macro definition at the cursor position in the text.
-
+Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
\end_layout
\begin_layout Description
-Syntax math-macro <NAME> [<NARGS>] [def]
+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.
\end_layout
\begin_layout Description
-Params <NAME>: The name of the macro, e.g.
- "mymacro".
- <NARGS>: The number of parameters of the macro.
- Default is 0.
- "def": Has no effect anymore, just for compatibility with former LyX versions.
-
+Syntax tab-delete
\end_layout
\begin_layout Description
-Origin ale, 10 May 1997; sts, 21 Dec 2007
+Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MUTATE
+tab-insert
\end_layout
\begin_layout Description
-Action Mutates the type of math inset to the newly selected one.
-
+Action Insert a tab into a listings inset.
\end_layout
\begin_layout Description
-Syntax math-mutate <TYPE>
+Notion It also works on a selection.
\end_layout
\begin_layout Description
-Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
- multline|gather|flalign
+Syntax tab-insert
\end_layout
\begin_layout Description
-Origin Andre, 23 May 2001
+Origin vfr, Sep 30 2008
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SPACE
+tabular-feature
\end_layout
\begin_layout Description
-Action Inserts space into math expression.
-
+Action Modify properties of tabulars and table-like math environments.
\end_layout
\begin_layout Description
-Notion Use spacebar after entering this space to change type of space.
-
+Syntax tabular-feature <FEATURE> [<ARG>]
\end_layout
\begin_layout Description
-Syntax math-space [<TYPE>]
-\end_layout
+Params Generally see LFUN_INSET_INSERT for further details.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <TYPE>: negative spaces: !|negmedspace|negthickspace
+<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
\begin_inset Newline newline
\end_inset
- positive spaces: ,|:|;|quad|qquad
+copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
\begin_inset Newline newline
\end_inset
- "," used by default.
-
-\end_layout
+set-line-top|set-line-bottom|set-line-left|set-line-right|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
-\end_layout
+toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_MATH_MATRIX
-\end_layout
+set-ltrim-top|set-rtrim-top|set-ltrim-bottom|set-rtrim-bottom
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Action Inserts a matrix.
-
-\end_layout
+toggle-ltrim-top|toggle-rtrim-top|toggle-ltrim-bottom|toggle-rtrim-bottom
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
-\end_layout
+align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-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).
-
+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
+
+reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
+\begin_inset Newline newline
+\end_inset
+
+set-longtabular|unset-longtabular|set-pwidth|
+\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|
+\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|
+\begin_inset Newline newline
+\end_inset
+
+toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
+\begin_inset Newline newline
+\end_inset
+
+the Grid/Array environment.
+\begin_inset Newline newline
+\end_inset
+
+<ARG>: additional argument for some commands, use debug mode to explore its values.
\end_layout
\begin_layout Description
-Sample math-matrix 3 3 bccc
+Origin gm, 10 Dec 2015
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MODE
+tabular-insert
\end_layout
\begin_layout Description
-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.
-
+Action Inserts table into the document.
\end_layout
\begin_layout Description
-Notion If there is some selected text, it puts the text inside created math
- box.
-
+Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
\end_layout
\begin_layout Description
-Syntax math-mode [<ARG>]
+Syntax tabular-insert [<ROWS> <COLUMNS>]
\end_layout
\begin_layout Description
-Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
- .
-
+Params In case no arguments are given show insert dialog.
\end_layout
\begin_layout Description
-Origin Alejandro, 4 Jun 1996
+Origin Jug, 12 Apr 2000
\end_layout
\begin_layout Subsection*
-LFUN_MATH_NUMBER_LINE_TOGGLE
+tabular-style-insert
\end_layout
\begin_layout Description
-Action Toggles numbering of the current formula line.
-
+Action Inserts table of a given style into the document.
\end_layout
\begin_layout Description
-Notion Must be in display formula mode.
-
+Notion See LFUN_TABULAR_FEATURE for some more details about tabular modifications.
+\end_layout
+
+\begin_layout Description
+Syntax tabular-style-insert <style> <ROWS> <COLUMNS>
\end_layout
\begin_layout Description
-Syntax math-number-line-toggle
+Params Valid styles are the names of the files in lib/tabletemplates, minus _1x<n> and .lyx suffix.
\end_layout
\begin_layout Description
-Origin Alejandro, 18 Jun 1996
+Origin spitz, 25 Mar 2019
\end_layout
\begin_layout Subsection*
-LFUN_MATH_NUMBER_TOGGLE
+thesaurus-entry
\end_layout
\begin_layout Description
-Action Toggles numbering/labeling of the current formula.
-
+Action Look up thesaurus entries with respect to the word under the cursor.
\end_layout
\begin_layout Description
-Notion Must be in display formula mode.
-
+Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
\end_layout
\begin_layout Description
-Syntax math-number-toggle
+Params <STRING>: word to look up <LANG>: language (see file languages)
\end_layout
\begin_layout Description
-Origin Alejandro, 4 Jun 1996
+Origin Levon, 20 Jul 2001
\end_layout
\begin_layout Subsection*
-LFUN_MATH_EXTERN
+undo
\end_layout
\begin_layout Description
-Action Calls external program and passes the current expression/equation
- as an argument for the calculation in the format appropriate to the given
- language.
-
+Action Undoes the last edit.
\end_layout
\begin_layout Description
-Notion Selection can be used to determine the input for the external program.
-
+Syntax undo
+\end_layout
+
+\begin_layout Subsection*
+unicode-insert
\end_layout
\begin_layout Description
-Syntax math-extern <LANG> [<COMMAND>]
+Action Inserts a single unicode character.
\end_layout
\begin_layout Description
-Params <LANG>: octave|maxima|maple|mathematica|script
-\begin_inset Newline newline
-\end_inset
+Syntax unicode-insert <CHAR1> <CHAR2> ...
+\end_layout
- where "script" stands fot the external script (normalized expression will
- be passed)
+\begin_layout Description
+Params <CHARn>: The character to insert, given as its code point, in hexadecimal.
\end_layout
\begin_layout Description
-Origin Andre, 24 Apr 2001
+Sample unicode-insert 0x0100 0x0259
\end_layout
\begin_layout Description
-Sample math-extern maple simplify
+Origin Lgb, 22 Oct 2006
\end_layout
\begin_layout Subsection*
-LFUN_MATH_SIZE
+up
\end_layout
\begin_layout Description
-Action Changes arbitrarily the size used by math fonts inside a context.
-
+Action Moves the cursor one line in upward direction.
\end_layout
\begin_layout Description
-Notion Provides an interface to the LaTeX math mode font size commands.
-
+Syntax up
\end_layout
-\begin_layout Description
-Syntax math-size <STYLE>
+\begin_layout Subsection*
+up-select
\end_layout
\begin_layout Description
-Params <STYLE>: displaystyle|
-\backslash
-textstyle|
-\backslash
-scriptstyle|
-\backslash
-scriptscriptstyle
+Action Moves the cursor one line in upward direction adding the current position to the selection.
\end_layout
\begin_layout Description
-Origin Alejandro, 15 Aug 1996; ps, 14 Jun 2008
+Syntax up-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_UNFOLD
-\end_layout
-
-\begin_layout Description
-Action Unfold a Math Macro.
-
+word-backward
\end_layout
\begin_layout Description
-Notion Unfold the Math Macro the cursor is in, i.e.
- display it as foo.
-
+Action Moves the cursor to the logically previous beginning of a word.
\end_layout
\begin_layout Description
-Syntax math-macro-unfold
+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
-Origin sts, 06 January 2008
+Syntax word-backward
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_FOLD
-\end_layout
-
-\begin_layout Description
-Action Fold a Math Macro.
-
+word-backward-select
\end_layout
\begin_layout Description
-Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
- displayed as foo before.
-
+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
-Syntax math-macro-fold
+Notion See also LFUN_WORD_BACKWARD.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Syntax word-backward-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_PARAM
+word-capitalize
\end_layout
\begin_layout Description
-Action Add a parameter.
-
+Action Capitalizes the words in the selection (i.e. the first letters) or the first letter of word at cursor position.
\end_layout
\begin_layout Description
-Notion Add a parameter to a Math Macro.
-
+Syntax word-capitalize [<SEL_TYPE>]
\end_layout
\begin_layout Description
-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.
-
+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 Description
-Syntax math-macro-add-param <NUM>
+\begin_layout Subsection*
+word-delete-backward
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
\end_layout
-\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_PARAM
+\begin_layout Description
+Syntax word-delete-backward [force]
\end_layout
\begin_layout Description
-Action Remove the last parameter.
-
+Params force: Delete big insets, do not only select them.
\end_layout
-\begin_layout Description
-Notion Remove the last parameter of a Math Macro and remove its value in
- all instances of the macro in the buffer.
-
+\begin_layout Subsection*
+word-delete-forward
\end_layout
\begin_layout Description
-Params <NUM>: The number of the parameter to be deleted (1 for the first),
- defaults to the last one.
-
+Action Deletes characters to the end of the word (usually the "C+Delete" key).
\end_layout
\begin_layout Description
-Syntax math-macro-remove-param <NUM>
+Syntax word-delete-forward [force]
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Params force: Delete big insets, do not only select them.
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
+word-find
\end_layout
\begin_layout Description
-Action Append a greedy parameter.
-
+Action Search for next occurrence of a string.
\end_layout
\begin_layout Description
-Notion Append a greedy parameter to a Math Macro which eats the following
- mathed cell in every instance of the macro in the buffer.
-
+Syntax word-find [<DATA>]
\end_layout
\begin_layout Description
-Syntax math-macro-append-greedy-param
+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).
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
+word-find-backward
\end_layout
\begin_layout Description
-Action Remove a greedy parameter.
-
+Action Search for a given string in backward direction.
\end_layout
\begin_layout Description
-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.
-
+Notion Case sensitive, match words. If no argument given, last search repeated.
\end_layout
\begin_layout Description
-Syntax math-macro-remove-greedy-param
+Syntax word-find-backward [<STRING>]
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Etienne, 20 Feb 1998
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_MAKE_OPTIONAL
+word-find-forward
\end_layout
\begin_layout Description
-Action Make a parameter optional.
-
+Action Search for a given string in forward direction.
\end_layout
\begin_layout Description
-Notion Turn the first non-optional parameter of a Math Macro into an optional
- parameter with a default value.
-
+Notion Case sensitive, match words. If no argument given, last search repeated.
\end_layout
\begin_layout Description
-Syntax math-macro-make-optional
+Syntax word-find-forward [<STRING>]
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin Etienne, 16 Feb 1998
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_MAKE_NONOPTIONAL
+word-findadv
\end_layout
\begin_layout Description
-Action Make a parameter non-optional.
-
+Action Search for next occurrence of a pattern.
\end_layout
\begin_layout Description
-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.
-
+Syntax word-findadv [<DATA>]
\end_layout
\begin_layout Description
-Syntax math-macro-make-nonoptional
+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
-Origin sts, 06 January 2008
+Origin Tommaso, Nov 15 2007
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
-\end_layout
-
-\begin_layout Description
-Action Add an optional parameter.
-
+word-forward
\end_layout
\begin_layout Description
-Notion Insert an optional parameter just behind the already existing optional
- parameters.
-
+Action Moves the cursor to the logically next beginning of a word.
\end_layout
\begin_layout Description
-Syntax math-macro-add-optional-param
+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
-Origin sts, 06 January 2008
+Syntax word-forward
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
-\end_layout
-
-\begin_layout Description
-Action Remove the last optional parameter.
-
+word-forward-select
\end_layout
\begin_layout Description
-Notion Remove the last optional parameter of a Math Macro and remove it
- in all the instances of the macro in the buffer.
-
+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
-Syntax math-macro-remove-optional-param
+Notion See also LFUN_WORD_FORWARD.
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Syntax word-forward-select
\end_layout
\begin_layout Subsection*
-LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
+word-left
\end_layout
\begin_layout Description
-Action Add a greedy optional parameter.
-
+Action Moves the cursor to the next beginning of a word "on the left".
\end_layout
\begin_layout Description
-Notion Add a greedy optional parameter which eats the value from the following
- cells in mathed which are in the [value] format.
-
+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
-Syntax math-macro-add-greedy-optional-param
+Syntax word-left
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_IN_MATHMACROTEMPLATE
+word-left-select
\end_layout
\begin_layout Description
-Action Only active in Math Macro definition.
-
+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
-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.
-
+Notion See also LFUN_WORD_LEFT for exact details of the movement.
\end_layout
\begin_layout Description
-Syntax in-mathmacrotemplate
+Syntax word-left-select
\end_layout
\begin_layout Description
-Origin sts, 06 January 2008
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_MOVE_DOWN
+word-lowcase
\end_layout
\begin_layout Description
-Action Moves the current paragraph downwards in the document.
-
+Action Change the words in the selection or word at cursor position to lower case.
\end_layout
\begin_layout Description
-Syntax paragraph-move-down
+Syntax word-lowcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Origin Edwin, 8 Apr 2006
+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*
-LFUN_PARAGRAPH_MOVE_UP
+word-replace
\end_layout
\begin_layout Description
-Action Moves the current paragraph upwards in the document.
-
+Action Replace a string in the document.
+\end_layout
+
+\begin_layout Description
+Syntax word-replace [<DATA>]
\end_layout
\begin_layout Description
-Syntax paragraph-move-up
+Params <DATA>: data is of the form "<replacestring>
+\begin_inset Newline newline
+\end_inset
+
+<searchstring>
+\begin_inset Newline newline
+\end_inset
+
+<casesensitive> <matchword> <all> <forward> <findnext>"
\end_layout
\begin_layout Description
-Origin Edwin, 8 Apr 2006
+Origin Andre, Jan 7 2004
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UP
+word-right
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
- one) in upward direction.
-
+Action Moves the cursor to the next beginning of a word "on the right".
+\end_layout
+
+\begin_layout Description
+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
-Syntax paragraph-up
+Syntax word-right
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UP_SELECT
+word-right-select
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
- of the current one) in upward direction.
-
+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
+Notion See also LFUN_WORD_RIGHT for exact details of the movement.
\end_layout
\begin_layout Description
-Syntax paragraph-up-select
+Syntax word-right-select
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Origin dov, 28 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_DOWN
+word-select
\end_layout
\begin_layout Description
-Action Move the cursor to the next paragraph (or begining of the current
- one) in downward direction.
-
+Action Puts the word where the cursor stands into the selection.
\end_layout
\begin_layout Description
-Syntax paragraph-down
+Syntax word-select
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+Origin Andre, 11 Sep 2002
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_DOWN_SELECT
+word-upcase
\end_layout
\begin_layout Description
-Action Move the cursor and select the text to the next paragraph (or begining
- of the current one) in downward direction.
-
+Action Change the words in the selection or word at cursor position to upper case.
\end_layout
\begin_layout Description
-Syntax paragraph-down-select
+Syntax word-upcase [<SEL_TYPE>]
\end_layout
\begin_layout Description
-Origin Asger, 1 Oct 1996
+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*
-LFUN_PARAGRAPH_GOTO
+wrap-insert
\end_layout
\begin_layout Description
-Action Jump to a paragraph given by its id number and optionally the desired
- position within the paragraph.
-
+Action Inserts floats wrapped by the text around.
\end_layout
\begin_layout Description
-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).
-
+Syntax wrap-insert <TYPE>
\end_layout
\begin_layout Description
-Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+Params <TYPE>: table|figure
\end_layout
\begin_layout Description
-Params <PAR_ID_NUMBER>: paragraph id
-\begin_inset Newline newline
-\end_inset
+Origin Dekel, 7 Apr 2002
+\end_layout
+
+\begin_layout Section
+Math Editor Functions
+\end_layout
- <POSITION_IN_PAR>: desired position within the paragraph
+\begin_layout Subsection*
+in-mathmacrotemplate
\end_layout
\begin_layout Description
-Origin Dekel, 26 Aug 2000
+Action Only active in Math Macro definition.
\end_layout
-\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
+\begin_layout Description
+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
-Action Breaks the current paragraph at the current location.
-
+Syntax in-mathmacrotemplate
\end_layout
\begin_layout Description
-Syntax break-paragraph
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
+math-ams-matrix
\end_layout
\begin_layout Description
-Action Breaks the current paragraph at the current location.
-
+Action Inserts an extended matrix as provided by the amsmath package.
\end_layout
\begin_layout Description
-Notion Removes the selection.
-
+Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
\end_layout
\begin_layout Description
-Syntax break-paragraph [<LAYOUT>]
+Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix, smallmatrix, and matrix. The default is 'matrix'.
\end_layout
\begin_layout Description
-Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
- default layout) when the cursor is at the end of the line.
-
+Sample math-ams-matrix 3 3 bmatrix
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_PARAMS
-\end_layout
-
-\begin_layout Description
-Action Change paragraph settings.
-
+math-bigdelim
\end_layout
\begin_layout Description
-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.
-
+Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
\end_layout
\begin_layout Description
-Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
+Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
\end_layout
\begin_layout Description
-Params <INDENT>:
-\backslash
-noindent|
-\backslash
-indent|
-\backslash
-indent-toggle|
-\backslash
-leftindent LENGTH
-\begin_inset Newline newline
-\end_inset
-
- <SPACING>:
-\backslash
-paragraph_spacing default|single|onehalf|double|other
+Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
\begin_inset Newline newline
\end_inset
- <ALIGN>:
-\backslash
-align block|left|right|center|default
-\begin_inset Newline newline
-\end_inset
+<L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
+\end_layout
- <OTHERS>:
+\begin_layout Description
+Sample math-bigdelim "Bigl" "
\backslash
-labelwidthstring WIDTH|
+Downarrow" "Bigr" "
\backslash
-start_of_appendix
-\begin_inset Newline newline
-\end_inset
-
-
+}"
\end_layout
\begin_layout Description
-Origin rgh, Aug 15 2007
+Origin Enrico & Georg, 7 May 2006
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_PARAMS_APPLY
+math-delim
\end_layout
\begin_layout Description
-Action Change paragraph settings.
-
+Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
\end_layout
\begin_layout Description
-Notion Overwrite all nonspecified settings to the default ones.
- Use paragraph-params lfun if you don't want to overwrite others settings.
-
+Syntax math-delim [<LEFT>] [<RIGHT>]
\end_layout
\begin_layout Description
-Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
+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
-Params For parameters see LFUN_PARAGRAPH_PARAMS
+Sample math-delim { rangle
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_PARAGRAPH_UPDATE
+math-display
\end_layout
\begin_layout Description
-Action Updates the values inside the paragraph dialog from the paragraph.
-
+Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
- Called internally by LFUN_DIALOG_UPDATE.
-
+Syntax math-display [<ARG>]
\end_layout
\begin_layout Description
-Origin leeming, 13 Mar 2003
+Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
+\end_layout
+
+\begin_layout Description
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_UP
+math-extern
+\end_layout
+
+\begin_layout Description
+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
+Notion Selection can be used to determine the input for the external program.
\end_layout
\begin_layout Description
-Action Move the current group in the upward direction in the structure of
- the document.
-
+Syntax math-extern <LANG> [<COMMAND>]
\end_layout
\begin_layout Description
-Notion The "group" can be Part/Chapter/Section/etc.
- It moves the whole substructure of the group.
-
+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
-Syntax outline-up
+Sample math-extern maple simplify
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Origin Andre, 24 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_DOWN
+math-font-style
\end_layout
\begin_layout Description
-Action Move the current group in the downward direction in the structure
- of the document.
-
+Action Changes the text style used in math.
\end_layout
\begin_layout Description
-Notion The "group" can be Part/Chapter/Section/etc.
- It moves the whole substructure of the group.
-
+Syntax math-font-style <STYLE>
\end_layout
\begin_layout Description
-Syntax outline-down
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
+\begin_inset Newline newline
+\end_inset
+
+|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Origin vfr, 9 jan 2009
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_IN
+math-insert
\end_layout
\begin_layout Description
-Action Moves the current group in the downward direction in the hierarchy
- of the document structure.
-
+Action Inserts math objects and symbols.
\end_layout
\begin_layout Description
-Notion Part -> Chapter -> Section -> etc.
-
+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
-Syntax outline-in
+Syntax math-insert <ARG>
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Params <ARG>: Symbol or LaTeX code to be inserted.
\end_layout
\begin_layout Subsection*
-LFUN_OUTLINE_OUT
+math-limits
\end_layout
\begin_layout Description
-Action Moves the current group in the upward direction in the hierarchy
- of the document structure.
-
+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
-Notion Part <- Chapter <- Section <- etc.
-
+Notion Put the cursor before the symbol with the limits and then invoke math-limits.
\end_layout
\begin_layout Description
-Syntax outline-out
+Syntax math-limits [<STATE>]
\end_layout
\begin_layout Description
-Origin Vermeer, 23 Mar 2006
+Params <STATE>: limits|nolimits
\end_layout
\begin_layout Subsection*
-LFUN_INSET_EDIT
+math-macro
\end_layout
\begin_layout Description
-Action Edit the inset at cursor with an external application, *
- if one is attributed.
-
+Action Inserts a math macro definition at the cursor position in the text.
\end_layout
\begin_layout Description
-Syntax inset-edit [<INSET_PARAMS>]
+Syntax math-macro <NAME> [<NARGS>] [def]
\end_layout
\begin_layout Description
-Params <INSET_PARAMS>: Parameters for the inset.
-
+Params <NAME>: The name of the macro, e.g. "mymacro".
\begin_inset Newline newline
\end_inset
- Currently only the filename will be considered.
-
+<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
-Origin JSpitzm, 27 Apr 2006
+Origin ale, 10 May 1997; sts, 21 Dec 2007
\end_layout
\begin_layout Subsection*
-LFUN_TABULAR_INSERT
+math-macro-add-greedy-optional-param
\end_layout
\begin_layout Description
-Action Inserts table into the document.
-
+Action Add a greedy optional parameter.
\end_layout
\begin_layout Description
-Syntax tabular-insert [<ROWS> <COLUMNS>]
+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
-Params In case no arguments are given show insert dialog.
-
+Syntax math-macro-add-greedy-optional-param
\end_layout
\begin_layout Description
-Origin Jug, 12 Apr 2000
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_TABULAR_FEATURE
+math-macro-add-optional-param
\end_layout
\begin_layout Description
-Action Sets various features to the table/cell on the current cursor position.
-
-\end_layout
-
-\begin_layout Description
-Notion Various math-environment features are handled here as well, e.g.
- add-vline-left/right for Grid/Cases environment
+Action Add an optional parameter.
\end_layout
\begin_layout Description
-Syntax tabular-feature <FEATURE> [<ARG>]
+Notion Insert an optional parameter just behind the already existing optional parameters.
\end_layout
\begin_layout Description
-Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
-y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
- align-left|align-right|align-center|align-block|valign-top|valign-bottom|
- valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top| m-valign-
-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines| set-longtabula
-r|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabu
-lar|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|
-set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot
-|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
- set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
-|set-bottom-space|set-interline-space|set-border-lines
-\begin_inset Newline newline
-\end_inset
-
- <ARG>: additional argument for some commands, use debug mode to explore
- its values.
-
+Syntax math-macro-add-optional-param
\end_layout
\begin_layout Description
-Origin Jug, 28 Jul 2000
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CELL_BACKWARD
+math-macro-add-param
\end_layout
\begin_layout Description
-Action Moves the cursor to the previous cell inside the table.
-
+Action Add a parameter.
\end_layout
\begin_layout Description
-Syntax cell-backward
+Notion Add a parameter to a Math Macro.
\end_layout
\begin_layout Description
-Origin Jug, 22 May 2000
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CELL_FORWARD
+Syntax math-macro-add-param <NUM>
\end_layout
\begin_layout Description
-Action Moves the cursor to the next cell inside the table.
-
+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
-Syntax cell-forward
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CELL_SPLIT
+math-macro-append-greedy-param
+\end_layout
+
+\begin_layout Description
+Action Append a greedy parameter.
\end_layout
\begin_layout Description
-Action Splits cell and shifts right part to the next cell (inside the math
- grid).
-
+Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
\end_layout
\begin_layout Description
-Syntax cell-split
+Syntax math-macro-append-greedy-param
\end_layout
\begin_layout Description
-Origin Ale, 15 May 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_REGISTER
+math-macro-fold
\end_layout
\begin_layout Description
-Action Register the document as an file inside version control system (RCS,
- CVS).
-
+Action Fold a Math Macro.
\end_layout
\begin_layout Description
-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 Extended Manual (Version Control Chapter) for additional information.
-
+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
-Syntax vc-register
+Syntax math-macro-fold
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_CHECK_IN
+math-macro-make-nonoptional
\end_layout
\begin_layout Description
-Action Checks-in/commits the changes of the registered file to the repository.
-
+Action Make a parameter non-optional.
\end_layout
\begin_layout Description
-Notion In RCS case this also unlocks the file.
-
+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
-Syntax vc-check-in
+Syntax math-macro-make-nonoptional
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_CHECK_OUT
+math-macro-make-optional
\end_layout
\begin_layout Description
-Action Checks-out the document for edit (and locks it for RCS).
-
+Action Make a parameter optional.
\end_layout
\begin_layout Description
-Notion This is implemented only for RCS and SVN, not CVS.
-
+Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
\end_layout
\begin_layout Description
-Syntax vc-check-out
+Syntax math-macro-make-optional
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_REVERT
+math-macro-remove-greedy-param
\end_layout
\begin_layout Description
-Action Reverts the document to the last check-in/commit in VCS.
-
+Action Remove a greedy parameter.
+\end_layout
+
+\begin_layout Description
+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
-Syntax vc-revert
+Syntax math-macro-remove-greedy-param
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_VC_UNDO_LAST
+math-macro-remove-optional-param
\end_layout
\begin_layout Description
-Action Undo last check-in.
-
+Action Remove the last optional parameter.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for RCS.
-
+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
-Syntax vc-check-out
+Syntax math-macro-remove-optional-param
\end_layout
\begin_layout Description
-Origin Lgb, 1 Jul 1997
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CHANGES_TRACK
+math-macro-remove-param
\end_layout
\begin_layout Description
-Action Toggles change tracking to on/off.
-
+Action Remove the last parameter.
\end_layout
\begin_layout Description
-Syntax changes-track
+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
-Origin levon, 1 Oct 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGES_OUTPUT
+Syntax math-macro-remove-param <NUM>
\end_layout
\begin_layout Description
-Action Toggles showing of change tracking in typesetted output.
-
+Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
\end_layout
\begin_layout Description
-Syntax changes-output
+Origin sts, 06 January 2008
\end_layout
-\begin_layout Description
-Origin jspitzm, 21 Jan 2005
+\begin_layout Subsection*
+math-macro-unfold
\end_layout
-\begin_layout Subsection*
-LFUN_CHANGE_NEXT
+\begin_layout Description
+Action Unfold a Math Macro.
\end_layout
\begin_layout Description
-Action Moves the cursor to the position of the next change of the change
- tracking records.
-
+Notion Unfold the Math Macro the cursor is in, i.e. display it as
+\backslash
+foo.
\end_layout
\begin_layout Description
-Syntax change-next
+Syntax math-macro-unfold
\end_layout
\begin_layout Description
-Origin schmitt, 4 Oct 2006
+Origin sts, 06 January 2008
\end_layout
\begin_layout Subsection*
-LFUN_CHANGES_MERGE
+math-matrix
\end_layout
\begin_layout Description
-Action Open change tracking dialog for merging and moves the cursor to the
- position of the next change.
-
+Action Inserts a matrix.
\end_layout
\begin_layout Description
-Syntax changes-merge
+Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CHANGE_ACCEPT
+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).
\end_layout
\begin_layout Description
-Action Accepts tracked change inside the selection.
-
+Sample math-matrix 3 3 bccc
\end_layout
-\begin_layout Description
-Syntax change-accept
+\begin_layout Subsection*
+math-mode
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+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 Subsection*
-LFUN_CHANGE_REJECT
+\begin_layout Description
+Notion If there is some selected text, it puts the text inside created math box.
\end_layout
\begin_layout Description
-Action Rejects tracked change inside the selection.
-
+Syntax math-mode [on|<ARG>]
\end_layout
\begin_layout Description
-Syntax change-accept
+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
-Origin Levon, 16 Oct 2002
+Origin Alejandro, 4 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_ALL_CHANGES_ACCEPT
+math-mutate
\end_layout
\begin_layout Description
-Action Accepts all tracked changes in the document.
-
+Action Mutates the type of math inset to the newly selected one.
+\end_layout
+
+\begin_layout Description
+Syntax math-mutate <TYPE>
\end_layout
\begin_layout Description
-Syntax all-changes-accept
+Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Origin Andre, 23 May 2001
\end_layout
\begin_layout Subsection*
-LFUN_ALL_CHANGES_REJECT
+math-number-line-toggle
\end_layout
\begin_layout Description
-Action Rejects all tracked changes in the document.
-
+Action Toggles numbering of the current formula line.
\end_layout
\begin_layout Description
-Notion Reject does not work recursively; the user may have to repeat the
- operation.
-
+Notion Must be in display formula mode.
\end_layout
\begin_layout Description
-Syntax all-changes-reject
+Syntax math-number-line-toggle
\end_layout
\begin_layout Description
-Origin Levon, 16 Oct 2002
+Origin Alejandro, 18 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_INSET_APPLY
+math-number-toggle
\end_layout
\begin_layout Description
-Action Apply data for an inset.
-
+Action Toggles numbering/labeling of the current formula.
\end_layout
\begin_layout Description
-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.
-
+Notion Must be in display formula mode.
\end_layout
\begin_layout Description
-Syntax inset-apply <ARGS>
+Syntax math-number-toggle
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT .
-
+Origin Alejandro, 4 Jun 1996
\end_layout
\begin_layout Subsection*
-LFUN_INSET_DISSOLVE
+math-size
\end_layout
\begin_layout Description
-Action Dissolve the current inset into text.
-
+Action Changes arbitrarily the size used by math fonts inside a context.
\end_layout
\begin_layout Description
-Syntax inset-dissolve [<INSET>]
+Notion Provides an interface to the LaTeX math mode font size commands.
\end_layout
\begin_layout Description
-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
+Syntax math-size <STYLE>
+\end_layout
- For values see lyx::InsetLayout::lyxtype_ .
-
+\begin_layout Description
+Params <STYLE>:
+\backslash
+displaystyle|
+\backslash
+textstyle|
+\backslash
+scriptstyle|
+\backslash
+scriptscriptstyle
\end_layout
\begin_layout Description
-Origin JSpitz, 7 Aug 2006
+Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_INSERT
+math-space
\end_layout
\begin_layout Description
-Action Insert new inset (type given by the parameters).
-
+Action Inserts space into math expression.
\end_layout
\begin_layout Description
-Syntax inset-insert <INSET> <ARGS>
+Notion Use spacebar after entering this space to change type of space.
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
-nclude|index|label|nomencl|vspace|ref|toc>
-\begin_inset Newline newline
-\end_inset
-
- <ARGS>: depends on the given inset.
- Use "lyx -dbg action" to explore.
-
+Syntax math-space [<TYPE>] [<LEN>]
\end_layout
\begin_layout Description
-Sample inset-insert ref LatexCommand <Format> reference "<label name>"
-\backslash
-end_inset
+Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
\begin_inset Newline newline
\end_inset
-where <label name> is the name of the referenced label and<Format> is one
- of the following:
+positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
\begin_inset Newline newline
\end_inset
-ref -- <reference>
+custom space: hspace
\begin_inset Newline newline
\end_inset
-eqref -- (<reference>)
+"," used by default.
\begin_inset Newline newline
\end_inset
-pageref -- <page>
+Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
\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
+<LEN>: length for custom spaces (hspace)
+\end_layout
-prettyref -- Formatted reference
+\begin_layout Description
+Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_MODIFY
+math-subscript
+\end_layout
+
+\begin_layout Description
+Action Enters subscript expression in math expression.
+\end_layout
+
+\begin_layout Description
+Syntax math-subscript
\end_layout
\begin_layout Description
-Action Modify existing inset.
-
+Origin vermeer, 12 Dec 2001
+\end_layout
+
+\begin_layout Subsection*
+math-superscript
\end_layout
\begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
-
+Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>
+Syntax math-superscript
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-
+Origin vermeer, 12 Dec 2001
\end_layout
\begin_layout Subsection*
-LFUN_NEXT_INSET_MODIFY
+regexp-mode
\end_layout
\begin_layout Description
-Action Modify the inset at cursor position, if there is one.
-
+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
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
-
+Notion If there is any selected text, then it is moved inside the created regexp inset.
\end_layout
\begin_layout Description
-Syntax next-inset-modify <INSET> <ARGS>
+Syntax regexp-mode [<ARG>]
\end_layout
\begin_layout Description
-Syntax next-inset-modify changetype <TYPE>
+Params <ARG>: eventual argument (regular expression).
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-
+Origin Tommaso, 4 Oct 2008
\end_layout
-\begin_layout Description
-Origin JSpitzm, 23 Mar 2008
+\begin_layout Section
+Buffer Fuctions (File and Window related)
\end_layout
\begin_layout Subsection*
-LFUN_INSET_DIALOG_UPDATE
+branch-activate
+\end_layout
+
+\begin_layout Description
+Action Activate the branch.
\end_layout
\begin_layout Description
-Action Updates the values inside the dialog from the inset.
-
+Syntax branch-activate <BRANCH>
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
- Called internally by LFUN_DIALOG_UPDATE
+Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
-Params <DIALOG-NAME>
+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
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin rgh, 27 May 2008
\end_layout
\begin_layout Subsection*
-LFUN_INSET_SETTINGS
+branch-add
\end_layout
\begin_layout Description
-Action Open the inset's properties dialog.
-
+Action Add a branch to the buffer's BranchList.
\end_layout
\begin_layout Description
-Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
-
+Syntax branch-add <BRANCH>
\end_layout
\begin_layout Description
-Syntax inset-settings <INSET>
+Params <BRANCH>: Name of the branch to add
\end_layout
\begin_layout Description
-Params <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
+Origin spitz, 7 Jul 2009
\end_layout
\begin_layout Subsection*
-LFUN_NEXT_INSET_TOGGLE
+branch-add-insert
\end_layout
\begin_layout Description
-Action Toggles the inset at cursor position.
- For collapsables, this means it will be (un-)collapsed, in case of other
- insets, the editing widget (dialog) will be entered.
- Also cf.
- LFUN_INSET_SETTINGS.
-
+Action Create new branch and directly put the branch inset into the document.
\end_layout
\begin_layout Description
-Notion Used for label, floats, listings, box, branch, external, wrap bibtex,
- ert, command, graphics, note, space, vspace, tabular, bibitem, inlude,
- ref insets.
-
+Syntax branch-add-insert [<NAME>]
\end_layout
\begin_layout Description
-Syntax next-inset-toggle <ARG>
+Params <NAME>: Branch name. If it is not specified, you will be asked.
\end_layout
\begin_layout Description
-Params <ARG>: these are passed as arguments to LFUN_INSET_TOGGLE .
-
+Origin sanda, 10 Jul 2009
\end_layout
-\begin_layout Description
-Origin leeming, 30 Mar 2004
+\begin_layout Subsection*
+branch-deactivate
\end_layout
-\begin_layout Subsection*
-LFUN_INSET_TOGGLE
+\begin_layout Description
+Action De-activate the branch.
\end_layout
\begin_layout Description
-Action Toggles the collapsable inset we are currently in.
-
+Syntax branch-deactivate <BRANCH>
\end_layout
\begin_layout Description
-Syntax inset-toggle [<ARG>]
+Params <BRANCH>: The branch to deactivate
\end_layout
\begin_layout Description
-Params <ARG>: <open|close|toggle|assign>.
-
-\begin_inset Newline newline
-\end_inset
+Origin rgh, 27 May 2008
+\end_layout
- open/close/toggle are for collapsable insets.
- close can be currently used by LFUN_NEXT_INSET_TOGGLE.
- toggle is used when no argument is given.
-
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsection*
+branch-invert
+\end_layout
+
+\begin_layout Description
+Action Toggles inversion status of branch inset.
+\end_layout
- assign is for branch inset.
-
+\begin_layout Description
+Syntax branch-invert
\end_layout
\begin_layout Description
-Origin lasgouttes, 19 Jul 2001
+Origin rgheck, 12 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_ALL_INSETS_TOGGLE
+branch-master-activate
\end_layout
\begin_layout Description
-Action Toggles (open/closes) all collapsable insets (of a given type) in
- the document.
-
+Action Activate the branch in the master buffer.
\end_layout
\begin_layout Description
-Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
-
+Syntax branch-master-activate <BRANCH>
\end_layout
\begin_layout Description
-Syntax all-insets-toggle <STATE> <INSET>
+Params <BRANCH>: The branch to activate
\end_layout
\begin_layout Description
-Params <STATE>: <toggle|open|close> default: toggle
+Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
\begin_inset Newline newline
\end_inset
- <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
- insets
+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
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin spitz, 30 Sep 2012
\end_layout
\begin_layout Subsection*
-LFUN_SET_GRAPHICS_GROUP
+branch-master-deactivate
\end_layout
\begin_layout Description
-Action Set the group for the graphics inset on the cursor position.
-
+Action De-activate the branch in the master buffer.
\end_layout
\begin_layout Description
-Syntax set-graphics-group [<GROUP>]
+Syntax branch-master-deactivate <BRANCH>
\end_layout
\begin_layout Description
-Params <GROUP>: Id for an existing group.
- In case the Id is an empty string, the graphics inset is removed from the
- current group.
-
+Params <BRANCH>: The branch to deactivate
\end_layout
\begin_layout Description
-Origin sanda, 6 May 2008
+Origin spitz, 30 Sep 2012
\end_layout
\begin_layout Subsection*
-LFUN_FINISHED_FORWARD
+branches-rename
+\end_layout
+
+\begin_layout Description
+Action Rename all branches of a given name in a document.
+\end_layout
+
+\begin_layout Description
+Syntax branches-rename <OLDNAME> <NEWNAME>
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going forward.
-
+Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
\end_layout
\begin_layout Description
-Notion Cursor movement within an inset may be different than cursor movement
- in the surrounding text.
- This action should be called automatically by the cursor movement within
- the inset, when movement within the inset has ceased (reached the end of
- the last paragraph, for example), in order to move correctly back into
- the surrounding text.
-
+Origin spitz, 9 Jul 2009
\end_layout
\begin_layout Subsection*
-LFUN_FINISHED_BACKWARD
+buffer-auto-save
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going backwards.
-
+Action Saves the current buffer to a temporary file.
+\end_layout
+
+\begin_layout Description
+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
-Notion See also LFUN_FINISHED_FORWARD.
-
+Syntax buffer-auto-save
\end_layout
\begin_layout Subsection*
-LFUN_FINISHED_RIGHT
+buffer-child-open
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going right.
-
+Action Loads the given child document.
\end_layout
\begin_layout Description
-Notion See also LFUN_FINISHED_FORWARD
+Notion The current document is treated as a parent.
\end_layout
-\begin_layout Subsection*
-LFUN_FINISHED_LEFT
+\begin_layout Description
+Syntax buffer-child-open <FILE>
\end_layout
\begin_layout Description
-Action Moves the cursor out of the current slice, going left.
-
+Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
\end_layout
\begin_layout Description
-Notion See also LFUN_FINISHED_FORWARD.
-
+Origin Ale, 28 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_LANGUAGE
+buffer-chktex
\end_layout
\begin_layout Description
-Action Set language from the current cursor position.
-
+Action Runs chktex for the current document.
\end_layout
\begin_layout Description
-Syntax language <LANG>
+Syntax buffer-chktex
\end_layout
\begin_layout Description
-Params <LANG>: Requested language.
- Look in lib/languages for the list.
-
+Origin Asger, 30 Oct 1997
+\end_layout
+
+\begin_layout Subsection*
+buffer-close
\end_layout
\begin_layout Description
-Origin Dekel, 2 Mar 2000
+Action Closes the current buffer.
\end_layout
-\begin_layout Subsection*
-LFUN_LABEL_GOTO
+\begin_layout Description
+Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
\end_layout
\begin_layout Description
-Action Goto a label.
-
+Syntax buffer-close
+\end_layout
+
+\begin_layout Subsection*
+buffer-close-all
\end_layout
\begin_layout Description
-Syntax label-goto [<LABEL>]
+Action Closes all buffers.
\end_layout
\begin_layout Description
-Params <LABEL>: Requested label.
- If no label is given and refernce is on cursor position, Bookmark 0 is
- saved and cursor moves to the position of referenced label.
-
+Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
\end_layout
\begin_layout Description
-Origin Ale, 6 Aug 1997
+Syntax buffer-close-all
\end_layout
\begin_layout Subsection*
-LFUN_LABEL_INSERT
+buffer-export
\end_layout
\begin_layout Description
-Action Inserts label to text or displayed formula.
-
+Action Exports the current buffer (document) to the given format.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-export [<FORMAT>] [<DEST>]
+\end_layout
+
+\begin_layout Description
+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.
+\begin_inset Newline newline
+\end_inset
+
+If absent or "default", then the default output format of the document is used.
+\begin_inset Newline newline
+\end_inset
+
+<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
+Origin Lgb, 29 Jul 1997
\end_layout
-\begin_layout Description
-Syntax label-insert [<LABEL>]
+\begin_layout Subsection*
+buffer-export-as
\end_layout
\begin_layout Description
-Params <LABEL>: Requested label.
- If no label is given dialog requesting name will be opened.
-
+Action Opens a dialog for exporting the current buffer.
\end_layout
-\begin_layout Subsection*
-LFUN_REFERENCE_NEXT
+\begin_layout Description
+Syntax buffer-export-as [<FORMAT>]
\end_layout
\begin_layout Description
-Action Go to the next label or cross-reference.
-
+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
-Syntax reference-next
+Sample buffer-export-as pdf2
\end_layout
\begin_layout Description
-Origin Dekel, 14 Jan 2001
+Origin tommaso, 6 Oct 2011
\end_layout
\begin_layout Subsection*
-LFUN_BOOKMARK_GOTO
+buffer-export-custom
\end_layout
\begin_layout Description
-Action Goto a bookmark.
-
+Action Exports the current buffer (document) from the given format using the given command on it.
\end_layout
\begin_layout Description
-Notion Moves the cursor to the numbered bookmark, opening the file if necessary.
- Note that bookmarsk are saved per-session, not per file.
-
+Syntax buffer-export-custom <FORMAT> <COMMAND>
\end_layout
\begin_layout Description
-Syntax bookmark-goto <NUMBER>
+Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
+\begin_inset Newline newline
+\end_inset
+
+<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
-Params <NUMBER>: the number of the bookmark to restore.
-
+Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
\end_layout
\begin_layout Description
-Origin Dekel, 27 January 2001
+Origin leeming, 27 Mar 2004
\end_layout
\begin_layout Subsection*
-LFUN_BOOKMARK_SAVE
+buffer-external-modification-clear
\end_layout
\begin_layout Description
-Action Save a bookmark.
-
+Action Clear the external modification flag on the current buffer.
\end_layout
\begin_layout Description
-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.
-
+Syntax buffer-external-modification-clear
\end_layout
\begin_layout Description
-Syntax bookmark-save <NUMBER>
+Origin gm, 2 March 2017
+\end_layout
+
+\begin_layout Subsection*
+buffer-forall
\end_layout
\begin_layout Description
-Params <NUMBER>: the number of the bookmark to save.
-
+Action Applies a command to all non-hidden buffers.
\end_layout
\begin_layout Description
-Origin Dekel, 27 January 2001
+Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
\end_layout
-\begin_layout Subsection*
-LFUN_BOOKMARK_CLEAR
+\begin_layout Description
+Syntax buffer-forall <LFUN-COMMAND>
\end_layout
\begin_layout Description
-Action Clears the list of saved bookmarks.
-
+Params <LFUN-COMMAND>: The command to be applied to the buffers.
\end_layout
\begin_layout Description
-Syntax bookmark-clear
+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 bpeng, 31 October 2006
+Origin skostysh, 20 Jul 2012
\end_layout
\begin_layout Subsection*
-LFUN_HELP_OPEN
+buffer-import
\end_layout
\begin_layout Description
-Action Open the given help file according to the language setting.
-
+Action Import a given file as a lyx document.
\end_layout
\begin_layout Description
-Syntax help-open <FILE>[.lyx]
+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
\begin_layout Description
-Params <FILE>: any document from (/usr/share/)doc directory.
-
+Syntax buffer-import <FORMAT> [<FILE>]
\end_layout
\begin_layout Description
-Origin Jug, 27 Jun 1999
+Origin Asger, 24 Jul 1998
\end_layout
\begin_layout Subsection*
-LFUN_LYX_QUIT
+buffer-language
\end_layout
\begin_layout Description
-Action Terminates the current LyX instance.
-
+Action Set language of the current document.
\end_layout
\begin_layout Description
-Notion Terminates the current LyX instance, asking whether to save modified
- documents, etc.
-
+Syntax buffer-language <LANG>
\end_layout
\begin_layout Description
-Syntax lyx-quit
-\end_layout
-
-\begin_layout Subsection*
-LFUN_TOOLBAR_TOGGLE
+Params <LANG>: language name. See lib/languages for list.
\end_layout
\begin_layout Description
-Action Toggles visibility of a given toolbar between on/off/auto.
-
+Origin leeming, 30 Mar 2004
\end_layout
-\begin_layout Description
-Notion Skiping "auto" when allowauto is false.
-
+\begin_layout Subsection*
+buffer-move-next
\end_layout
\begin_layout Description
-Syntax toolbar-toggle <NAME> [allowauto]
+Action Moves the current tab one spot to the right.
\end_layout
\begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
-ew/update|math_panels|vcs
+Syntax buffer-move-next
\end_layout
\begin_layout Description
-Origin Edwin, 21 May 2007
+Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
-LFUN_MENU_OPEN
+buffer-move-previous
\end_layout
\begin_layout Description
-Action Opens the menu given by its name.
-
+Action Moves the current tab one spot to the left.
\end_layout
\begin_layout Description
-Syntax menu-open <NAME>
+Syntax buffer-move-previous
\end_layout
\begin_layout Description
-Params <NAME>: menu name.
- See various .inc files in lib/ui for candidates.
-
+Origin skostysh, 7 Apr 2015
\end_layout
\begin_layout Subsection*
-LFUN_UI_TOGGLE
+buffer-new
\end_layout
\begin_layout Description
-Action Various UI visibility-toggling actions.
-
+Action Creates a new buffer (that is, document) and switches to it.
\end_layout
\begin_layout Description
-Syntax ui-toggle <statusbar|menubar|frame|fullscreen>
+Notion Implicit path can be set in Preferences dialog.
\end_layout
\begin_layout Description
-Params statusbar : Toggle visibility of the statusbar.
-
-\begin_inset Newline newline
-\end_inset
-
- menubar : Toggle visibility of the menubar.
-
-\begin_inset Newline newline
-\end_inset
-
- 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
-
- 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.
-
+Syntax buffer-new [<FILE>]
\end_layout
\begin_layout Description
-Origin sanda, 9 Feb 2007
+Params <FILE>: filename of created file with absolute path.
\end_layout
\begin_layout Subsection*
-WINDOW_NEW
-\end_layout
-
-\begin_layout Description
-Action Creates new empty LyX window.
-
+buffer-new-template
\end_layout
\begin_layout Description
-Notion Already opened documents from the previous window can be found under
- View menu.
-
+Action Creates a new buffer (that is, document) from a template.
\end_layout
\begin_layout Description
-Syntax window-new [<GEOMETRY>]
+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
-Params <GEOMETRY>: pass the geometry of the window.
- This parameter is currently accepted only on Windows platform.
-
+Syntax buffer-new-template [<FILE>] [<TEMPLATE FILE>]
\end_layout
\begin_layout Description
-Origin Abdel, 21 Oct 2006
+Params <FILE>: filename of created file with absolute path. If empty or "newfile", a file with appropriate name is generated. <TEMPLATE FILE>: filename of template with absolute path. If empty, a dialog is opened to select the new file.
\end_layout
\begin_layout Subsection*
-LFUN_WINDOW_CLOSE
+buffer-next
\end_layout
\begin_layout Description
-Action Closes the current LyX window.
-
+Action Switch to the next opened document.
\end_layout
\begin_layout Description
-Syntax window-close
+Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
\end_layout
\begin_layout Description
-Origin Abdel, 23 Oct 2006
+Syntax buffer-next
\end_layout
\begin_layout Subsection*
-LFUN_SPLIT_VIEW
+buffer-params-apply
\end_layout
\begin_layout Description
-Action Creates another split view of current buffer.
-
+Action Apply the given settings to the current document.
\end_layout
\begin_layout Description
-Notion All split views act in the same way indpendently.
-
+Syntax buffer-params-apply [<ARGS>]
\end_layout
\begin_layout Description
-Syntax split-view <vertical|horizontal>
+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
-Params horizontal : The work areas are laid out side by side.
-
-\begin_inset Newline newline
-\end_inset
+Origin leeming, 30 Mar 2004
+\end_layout
+
+\begin_layout Subsection*
+buffer-previous
+\end_layout
- vertical : The work areas laid out vertically.
-
+\begin_layout Description
+Action Switch to the previous opened document.
\end_layout
\begin_layout Description
-Origin Abdel, 20 Feb 2008
+Syntax buffer-previous
\end_layout
\begin_layout Subsection*
-LFUN_CLOSE_TAB_GROUP
+buffer-reload
\end_layout
\begin_layout Description
-Action Close the current tab group.
-
+Action Reverts opened document.
\end_layout
\begin_layout Description
-Notion This only closes the work areas, not the buffer themselves.
- The still opened buffers can be visualized in another tab group.
-
+Syntax buffer-reload [dump]
\end_layout
\begin_layout Description
-Syntax close-tab-group
+Params dump: do not ask for any confirmation, just reload. All changes will be lost.
\end_layout
\begin_layout Description
-Origin Abdel, 21 Feb 2008
+Origin Asger, 2 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_SHOW
+buffer-save-as-default
\end_layout
\begin_layout Description
-Action Shows hidden dialog or create new one for a given function/inset
- settings etc.
-
+Action Save the current document settings as default.
\end_layout
\begin_layout Description
-Syntax dialog-show <NAME> [<DATA>]
+Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
\end_layout
\begin_layout Description
-Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
-
-\begin_inset Newline newline
-\end_inset
-
- document|errorlist|ert|external|file|findreplace|float|graphics|
-\begin_inset Newline newline
-\end_inset
-
- include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
-\begin_inset Newline newline
-\end_inset
-
- note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
-\begin_inset Newline newline
-\end_inset
-
- tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace
-\begin_inset Newline newline
-\end_inset
-
- wrap|listings|<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.
-
+Syntax buffer-save-as-default [<ARGS>]
\end_layout
\begin_layout Description
-Origin leeming, 17 Jun 2003
-\end_layout
-
-\begin_layout Subsection*
-LFUN_DIALOG_SHOW_NEW_INSET
+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
-Action Shows hidden dialog or create new one for a given inset settings
- etc.
-
+Origin leeming, 30 Mar 2004
\end_layout
-\begin_layout Description
-Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
- inset.
-
+\begin_layout Subsection*
+buffer-switch
\end_layout
\begin_layout Description
-Syntax dialog-show-new-inset <NAME> [<DATA>]
+Action Display and switch to the given buffer.
\end_layout
\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
-
+Syntax buffer-switch <BUFFER>
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_UPDATE
-\end_layout
-
-\begin_layout Description
-Action Updates the dialog values from the inset/paragraph/document.
-
+buffer-toggle-compression
\end_layout
\begin_layout Description
-Syntax dialog-update <NAME>
+Action Toggles compression of the current document on/off.
\end_layout
\begin_layout Description
-Params <NAME>: paragraph|prefs|<INSET>
-\begin_inset Newline newline
-\end_inset
-
- <INSET>: inset name
+Syntax buffer-toggle-compression
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin bpeng, 27 Apr 2006
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_HIDE
+buffer-toggle-read-only
\end_layout
\begin_layout Description
-Action Hides showed dialog.
- Counterpart to LFUN_DIALOG_SHOW .
-
+Action Toggle editing mode of the current document between read/write and read-only.
\end_layout
\begin_layout Description
-Syntax dialog-hide <NAME>
+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.
\end_layout
\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
-
+Syntax buffer-toggle-read-only
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+Origin Lgb, 27 May 1997
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_TOGGLE
+buffer-update
\end_layout
\begin_layout Description
-Action Toggles dialog between showed/hidden state.
-
+Action Exports the current document and put the result into the temporary directory.
\end_layout
\begin_layout Description
-Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
-
+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).
\end_layout
\begin_layout Description
-Syntax dialog-toggle <NAME> [<DATA>]
+Syntax buffer-update [<FORMAT>]
\end_layout
\begin_layout Description
-Params See LFUN_DIALOG_SHOW .
-
+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 Description
-Origin JSpitzm, 30 Apr 2007
+Origin Dekel, 5 Aug 2000
\end_layout
\begin_layout Subsection*
-LFUN_DIALOG_DISCONNECT_INSET
+buffer-view
\end_layout
\begin_layout Description
-Action Closes opened connection to opened inset.
-
+Action Displays current buffer in chosen format.
\end_layout
\begin_layout Description
-Notion Connection is used for apply functions.
-
+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
-Syntax dialog-disconnect-inset <INSET-NAME>
+Syntax buffer-view [<FORMAT>]
\end_layout
\begin_layout Description
-Origin leeming, 25 Feb 2003
+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*
-LFUN_MOUSE_PRESS
+buffer-view-cache
\end_layout
\begin_layout Description
-Action This function is called when mouse button is pressed (inside workarea).Act
-ion depends on the context.
-
+Action Opens the file that was created from last preview of this buffer.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
-
+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
-Origin Andre, 9 Aug 2002
+Syntax buffer-view-cache
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_DOUBLE
+buffer-write
\end_layout
\begin_layout Description
-Action This function is called when double click on mouse button is pressed
- (inside workarea).
- Action depends on the context.
-
+Action Saves the current buffer.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
-
+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
-Origin Andre, 9 Aug 2002
+Syntax buffer-write
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_TRIPLE
+buffer-write-all
\end_layout
\begin_layout Description
-Action This function is called when triple click on mouse button is pressed
- (inside workarea).
- Action depends on the context.
-
+Action Save all changed documents.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
-
+Syntax buffer-write-all
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+Origin rgh, gpothier 6 Aug 2007
\end_layout
\begin_layout Subsection*
-LFUN_MOUSE_MOTION
+buffer-write-as
\end_layout
\begin_layout Description
-Action This function is called when mouse cursor is moving over the text.Action
- depends on the context.
-
+Action Rename and save current buffer.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
-
+Syntax buffer-write-as <FILENAME>
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+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*
-LFUN_MOUSE_RELEASE
+buffer-write-as-template
\end_layout
\begin_layout Description
-Action This function is called when mouse button is released (inside workarea).Ac
-tion depends on the context.
-
+Action Rename and save current buffer in the local templates directory.
\end_layout
\begin_layout Description
-Notion This is internal LFUN, not to be used by users.
-
+Syntax buffer-write-as-template <FILENAME>
\end_layout
\begin_layout Description
-Origin Andre, 9 Aug 2002
+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*
-LFUN_KEYMAP_OFF
+buffer-zoom
\end_layout
\begin_layout Description
-Action Turn off the loaded keyboard map.
-
+Action Sets the zoom of the screen fonts.
\end_layout
\begin_layout Description
-Syntax keymap-off
-\end_layout
-
-\begin_layout Subsection*
-LFUN_KEYMAP_PRIMARY
+Syntax buffer-zoom [<ZOOM>]
\end_layout
\begin_layout Description
-Action Turn on the primary keyboard map.
-
+Params <ZOOM>: The target zoom value in %; the default is the default zoom as saved in preferences.
\end_layout
\begin_layout Description
-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
- plaforms.
-
-\begin_inset Newline newline
-\end_inset
+Origin daniel, 28 Oct 2016
+\end_layout
- The language is to be set in the Preferences dialog.
-
+\begin_layout Subsection*
+buffer-zoom-in
\end_layout
\begin_layout Description
-Syntax keymap-primary
+Action Increases the zoom of the screen fonts.
\end_layout
-\begin_layout Subsection*
-LFUN_KEYMAP_SECONDARY
+\begin_layout Description
+Syntax buffer-zoom-in [<ZOOM>]
\end_layout
\begin_layout Description
-Action Turn on the secondary keyboard map.
-
+Params <ZOOM>: The zoom value addition in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
\end_layout
\begin_layout Description
-Syntax keymap-secondary
+Origin vfr, 30 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_KEYMAP_TOGGLE
+buffer-zoom-out
\end_layout
\begin_layout Description
-Action Toggles keyboard maps (first/second/off).
-
+Action Decreases the zoom of the screen fonts.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-zoom-out [<ZOOM>]
\end_layout
\begin_layout Description
-Syntax keymap-toggle
+Params <ZOOM>: The zoom value abstraction in % (neg. or pos.); the default is 10% of the default zoom as saved in preferences.
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin vfr, 30 Mar 2009
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GET_LAYOUT
+build-program
\end_layout
\begin_layout Description
-Action Returns the current layout (that is environment) name on the cursor
- position.
-
+Action Generates the code (literate programming).
\end_layout
\begin_layout Description
-Syntax server-get-layout
-\end_layout
+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
-\begin_layout Subsection*
-LFUN_SERVER_GET_FILENAME
-\end_layout
+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
-\begin_layout Description
-Action Returns path and file name of the currently edited document.
-
+
+\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
-Syntax server-get-filename
+Syntax build-program
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GOTO_FILE_ROW
+file-open
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the row number of generated TeX
- file.
-
+Action Open LyX document.
\end_layout
\begin_layout Description
-Syntax server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
+Syntax file-open [<FILE>]
\end_layout
\begin_layout Description
-Origin Edmar, 23 Dec 1998
+Params <FILE>: Filename to be opened.
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_NOTIFY
+help-open
\end_layout
\begin_layout Description
-Action Sends notify message about the last key-sequence to client.
-
+Action Open the given help file according to the language setting.
+\end_layout
+
+\begin_layout Description
+Syntax help-open <FILE>[.lyx]
\end_layout
\begin_layout Description
-Notion This can be used to grab last key-sequence used inside the LyX window.
-
+Params <FILE>: any document from (/usr/share/)doc directory.
\end_layout
\begin_layout Description
-Syntax server-notify
+Origin Jug, 27 Jun 1999
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_SET_XY
+icon-size
+\end_layout
+
+\begin_layout Description
+Action Sets icon size of toolbars.
+\end_layout
+
+\begin_layout Description
+Syntax icon-size [<SIZE>]
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the editing area coordinates (similar
- as clicking on that point with left mouse button).
-
+Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
\end_layout
\begin_layout Description
-Syntax server-set-xy <X> <Y>
+Origin 11 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_SERVER_GET_XY
+lyx-quit
\end_layout
\begin_layout Description
-Action Returns the coordinates of cursor position in the editing area.
-
+Action Terminates the current LyX instance.
+\end_layout
+
+\begin_layout Description
+Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
\end_layout
\begin_layout Description
-Syntax server-get-xy
+Syntax lyx-quit
\end_layout
\begin_layout Subsection*
-LFUN_BUILD_PROGRAM
+master-buffer-export
\end_layout
\begin_layout Description
-Action Generates the code (literate programming).
-
+Action Exports the master buffer (document) to the given format.
+\end_layout
+
+\begin_layout Description
+Syntax master-buffer-export [<FORMAT>] [<DEST>]
\end_layout
\begin_layout Description
-Notion Latex file with extension literate_extension is generated.
- Then LyX invokes build_command (with a default of``make'') to generate
- the code and build_error_filter to process the compilation error messages.
-
+Params <FORMAT> is 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 you want to process your literate file with a script, or some other
- program, just insert in your lyxrc file an entry with:
+Note that "custom" is not allowed in this case.
\begin_inset Newline newline
\end_inset
- build_command "my_script my_arguments"
+If absent or "default", then the default output format of the document is used.
\begin_inset Newline newline
\end_inset
- The build_error_filter differs from the literate_error_filter only in that
- the former will identify error messages from your compiler.
-
+<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
-Syntax build-program
+Origin rkh, 18 April 2018
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_AUTO_SAVE
+master-buffer-update
\end_layout
\begin_layout Description
-Action Saves the current buffer to a temporary file.
-
+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
-Notion Saves the current buffer to a file named "#filename#".
- This LFUN is called automatically by LyX, to "autosave" the current buffer.
-
+Syntax master-buffer-update [<FORMAT>]
\end_layout
\begin_layout Description
-Syntax buffer-auto-save
+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*
-LFUN_BUFFER_CHILD_OPEN
+\begin_layout Description
+Origin Tommaso, 20 Sep 2007
\end_layout
-\begin_layout Description
-Action Loads the given child document.
-
+\begin_layout Subsection*
+master-buffer-view
\end_layout
\begin_layout Description
-Notion The current document is treated as a parent.
-
+Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
\end_layout
\begin_layout Description
-Syntax buffer-child-open <FILE>
+Syntax master-buffer-view [<FORMAT>]
\end_layout
\begin_layout Description
-Params <FILE>: Filename of the child.
- The directory of the parent is assumed by default.
-
+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 Description
-Origin Ale, 28 May 1997
+Origin Tommaso, 20 Sep 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CHKTEX
+menu-open
\end_layout
\begin_layout Description
-Action Runs chktex for the current document.
-
+Action Opens the menu given by its name.
\end_layout
\begin_layout Description
-Syntax buffer-chktex
+Syntax menu-open <NAME>
\end_layout
\begin_layout Description
-Origin Asger, 30 Oct 1997
+Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_TOGGLE_COMPRESSION
+tab-group-close
\end_layout
\begin_layout Description
-Action Toggles compression of the current document on/off.
-
+Action Close the current tab group.
\end_layout
\begin_layout Description
-Syntax buffer-toggle-compression
+Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
\end_layout
\begin_layout Description
-Origin bpeng, 27 Apr 2006
+Syntax tab-group-close
+\end_layout
+
+\begin_layout Description
+Origin Abdel, 21 Feb 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_CLOSE
+toolbar-movable
\end_layout
\begin_layout Description
-Action Closes the current buffer.
-
+Action Toggles movability of a given toolbar between true/false.
\end_layout
\begin_layout Description
-Notion Closes the current buffer, asking whether to save it, etc, if the
- buffer has been modified.
-
+Syntax toolbar-movable <NAME>
\end_layout
\begin_layout Description
-Syntax buffer-close
+Params <NAME>: *|standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
+\end_layout
+
+\begin_layout Description
+Origin daniel, 12 July 2016
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_EXPORT
+toolbar-toggle
\end_layout
\begin_layout Description
-Action Exports the current buffer (document) to the given format.
-
+Action Toggles visibility of a given toolbar between on/off/auto.
+\end_layout
+
+\begin_layout Description
+Notion Skipping "auto" when allowauto is false.
\end_layout
\begin_layout Description
-Syntax buffer-export <FORMAT>
+Syntax toolbar-toggle <NAME> [allowauto]
\end_layout
\begin_layout Description
-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.
-
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
\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.
-
+minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
-Origin Lgb, 29 Jul 1997
+Origin Edwin, 21 May 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_EXPORT_CUSTOM
+ui-toggle
\end_layout
\begin_layout Description
-Action Exports the current buffer (document) from the given format using
- the given command on it.
-
+Action Various UI visibility-toggling actions.
\end_layout
\begin_layout Description
-Syntax buffer-export-custom <FORMAT> <COMMAND>
+Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
\end_layout
\begin_layout Description
-Params <FORMAT> format to start from (LyX will care to produce such intermediate
- file).
-
+Params statusbar : Toggle visibility of the statusbar.
+\begin_inset Newline newline
+\end_inset
+
+menubar : Toggle visibility of the menubar.
+\begin_inset Newline newline
+\end_inset
+
+scrollbar : Toggle visibility of the scrollbar.
\begin_inset Newline newline
\end_inset
- <COMMAND> this command will be launched on the file.
- Note that you can use "$$FName" string to qualify the intermediate file.
-
+frame : Toggle visibility of the frames around editing window.
+\begin_inset Newline newline
+\end_inset
+
+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
+Origin sanda, 9 Feb 2007
+\end_layout
+
+\begin_layout Subsection*
+view-close
+\end_layout
+
+\begin_layout Description
+Action Close the current document work area.
\end_layout
\begin_layout Description
-Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
+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
-Origin leeming, 27 Mar 2004
+Syntax view-close
+\end_layout
+
+\begin_layout Description
+Origin Tommaso, 15 Sep 2012
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_PRINT
+view-split
\end_layout
\begin_layout Description
-Action Prints the current document.
-
+Action Creates another split view of current buffer.
\end_layout
\begin_layout Description
-Notion Many settings can be given via the preferences dialog.
-
+Notion All split views act in the same way independently.
\end_layout
\begin_layout Description
-Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
+Syntax view-split <vertical|horizontal>
\end_layout
\begin_layout Description
-Params <TARGET> is either "printer" or "file".
-
-\begin_inset Newline newline
-\end_inset
-
- <TARGER-NAME> is either "default" or file name or printer name.
-
+Params horizontal : The work areas are laid out side by side.
\begin_inset Newline newline
\end_inset
- <COMMAND> command ensuring the printing job.
-
+vertical : The work areas laid out vertically.
\end_layout
\begin_layout Description
-Sample buffer-print file "/trash/newfile1.ps" "dvips"
-\end_layout
-
-\begin_layout Description
-Origin leeming, 28 Mar 2004
+Origin Abdel, 20 Feb 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_IMPORT
+window-close
\end_layout
\begin_layout Description
-Action Import a given file as a lyx document.
-
+Action Closes the current LyX window.
\end_layout
\begin_layout Description
-Notion File can be imported iff lyx file format is (transitively) reachable
- via defined convertors in preferences.
- Look into File->Import menu to get an idea of the currently active import
- formats.
-
+Syntax window-close
\end_layout
\begin_layout Description
-Syntax buffer-import <FORMAT> [<FILE>]
+Origin Abdel, 23 Oct 2006
\end_layout
-\begin_layout Description
-Origin Asger, 24 Jul 1998
+\begin_layout Subsection*
+window-new
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_NEW
+\begin_layout Description
+Action Creates new empty LyX window.
\end_layout
\begin_layout Description
-Action Creates a new buffer (that is, document).
-
+Notion Already opened documents from the previous window can be found under View menu.
\end_layout
\begin_layout Description
-Notion Implicit path can be set in Preferences dialog.
-
+Syntax window-new [<GEOMETRY>]
\end_layout
\begin_layout Description
-Syntax buffer-new [<FILE>]
+Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
\end_layout
\begin_layout Description
-Params <FILE>: filename of created file with absolute path.
-
+Origin Abdel, 21 Oct 2006
+\end_layout
+
+\begin_layout Section
+System Functions (Preferences, LyX Server etc.)
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_NEW_TEMPLATE
+bidi
\end_layout
\begin_layout Description
-Action Creates a new buffer (that is, document) from a template.
-
+Action Helper function for bidirectional toolbar icons
\end_layout
\begin_layout Description
-Notion Path for new files and templates can be set in Preferences dialog.
- Template will be asked for via Open-dialog.
-
+Notion In a text, the function is marked as `unknown' when the current direction does not correspond to DIRECTION (ltr or rtl). Otherwise the function behaves exactly as ACTION. The result is that ACTION will be associated to a different icon depending on text direction.
\end_layout
\begin_layout Description
-Syntax buffer-new-template [<FILE>]
+Syntax bidi <DIRECTION> <ACTION>
\end_layout
\begin_layout Description
-Params <FILE>: filename of created file with absolute path.
-
+Origin JMarc, 21 July 2019
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_RELOAD
+buffer-toggle-output-sync
\end_layout
\begin_layout Description
-Action Reverts opened document.
-
+Action Toggles including of resources for forward/reverse search of the given document.
+\end_layout
+
+\begin_layout Description
+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
-Syntax buffer-reload
+Syntax buffer-toggle-output-sync
\end_layout
\begin_layout Description
-Origin Asger, 2 Feb 1997
+Origin sanda, 25 May 2010
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_SWITCH
+call
\end_layout
\begin_layout Description
-Action Switch to the given buffer.
-
+Action Executes a command defined in a .def file.
+\end_layout
+
+\begin_layout Description
+Notion The definitions are by default read from lib/commands/default.def.
+\begin_inset Newline newline
+\end_inset
+
+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.
+\begin_inset Newline newline
+\end_inset
+
+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
\begin_layout Description
-Notion This is useful also in case you need simultaneously more views of
- the edited document in different LyX windows.
-
+Syntax call <NAME>
\end_layout
\begin_layout Description
-Syntax buffer-new-template <BUFFER>
+Params <NAME>: Name of the command that must be called.
\end_layout
\begin_layout Description
-Params <BUFFER>: already opened document which is to be shown.
-
+Origin broider, 2 Oct 2007
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_TOGGLE_READ_ONLY
+cancel
\end_layout
\begin_layout Description
-Action Toggle editing mode of the current document between read/write and
- read-only.
-
+Action Cancels sequence prepared by LFUN_META_PREFIX .
\end_layout
\begin_layout Description
-Notion In the ->Readonly mode checks-in/commits the data if the file is
- under version control.
- In the Readonly-> mode checkouts the data from repository.
-
-\begin_inset Newline newline
-\end_inset
-
- If these operations fail, buffer won't be toggled.
-
+Syntax cancel
\end_layout
-\begin_layout Description
-Syntax buffer-toggle-read-only
+\begin_layout Subsection*
+command-alternatives
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 1997
+Action Runs the first listed command that is enabled.
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_VIEW
+\begin_layout Description
+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
-Action Displays current buffer in chosen format.
-
+Syntax command-alternatives <CMDS>
\end_layout
\begin_layout Description
-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.
-
+Params <CMDS>: Sequence of commands separated by semicolons.
\end_layout
\begin_layout Description
-Syntax buffer-view <FORMAT>
+Sample command-alternatives completion-accept;cell-forward
\end_layout
\begin_layout Description
-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.
-
+Origin rgh, 24 September 2008
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_UPDATE
+command-sequence
\end_layout
\begin_layout Description
-Action Exports the current document and put the result into the temporary
- directory.
-
+Action Run more commands (LFUN and its parameters) in a sequence.
\end_layout
\begin_layout Description
-Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
-EW) the output will be rewriten - updated.
- This is useful in case your viewer is able to detect such changes (e.g.
- ghostview for postscript).
-
+Syntax command-sequence <CMDS>
\end_layout
\begin_layout Description
-Syntax buffer-update <FORMAT>
+Params <CMDS>: Sequence of commands separated by semicolons.
\end_layout
\begin_layout Description
-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.
-
+Sample command-sequence cut; ert-insert; self-insert
+\backslash
+; paste; self-insert {}; inset-toggle;
\end_layout
\begin_layout Description
-Origin Dekel, 5 Aug 2000
+Origin Andre, 11 Nov 1999
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_WRITE
+cursor-follows-scrollbar-toggle
\end_layout
\begin_layout Description
-Action Saves the current buffer.
-
+Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
\end_layout
\begin_layout Description
-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.
-
+Syntax toggle-cursor-follows-scrollbar
\end_layout
\begin_layout Description
-Syntax buffer-write
+Origin ARRae, 2 Dec 1997
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_WRITE_AS
+debug-level-set
\end_layout
\begin_layout Description
-Action Rename and save current buffer.
-
+Action Set debug output level.
\end_layout
\begin_layout Description
-Syntax buffer-write-as <FILENAME>
+Syntax debug-level-set <LEVEL>
\end_layout
\begin_layout Description
-Params <FILENAME>: New name of the buffer/file.
- A relative path is with respect to the original location of the buffer/file.
-
+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 Subsection*
-LFUN_BUFFER_WRITE_ALL
+\begin_layout Description
+Origin sanda, 28 Dec 2009
\end_layout
-\begin_layout Description
-Action Save all changed documents.
-
+\begin_layout Subsection*
+devel-mode-toggle
\end_layout
\begin_layout Description
-Syntax buffer-write-all
+Action toggle a mode where more information is given in UI
\end_layout
\begin_layout Description
-Origin rgh, gpothier 6 Aug 2007
+Notion in so called "devel" mode, the information given in the status bar is more precise, and the help documents are open in editing mode.
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_NEXT
+\begin_layout Description
+Syntax devel-mode-toggle
\end_layout
\begin_layout Description
-Action Switch to the next opened document.
-
+Origin lasgouttes, 23 Jul 2017
\end_layout
-\begin_layout Description
-Notion Note that this does not necessarily mean next in tabbar (for full
- list see View menu).
-
+\begin_layout Subsection*
+forward-search
\end_layout
\begin_layout Description
-Syntax buffer-next
+Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_PREVIOUS
+\begin_layout Description
+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
\begin_layout Description
-Action Switch to the previous opened document.
-
+Syntax forward-search
\end_layout
\begin_layout Description
-Syntax buffer-previous
+Origin sanda, 14 Apr 2010
\end_layout
\begin_layout Subsection*
-LFUN_MASTER_BUFFER_UPDATE
+lyxrc-apply
\end_layout
\begin_layout Description
-Action When run from a child document, this updates (exports) document built
- from the master buffer.
- If a master is not found, it updates the current buffer.
-
+Action Apply the given settings to user preferences.
\end_layout
\begin_layout Description
-Syntax master-buffer-update
+Syntax lyxrc-apply <SETTINGS>
\end_layout
\begin_layout Description
-Origin Tommaso, 20 Sep 2007
+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*
-LFUN_MASTER_BUFFER_VIEW
+message
\end_layout
\begin_layout Description
-Action When run from a child document, this command shows a preview built
- from the master buffer.
- If a master is not found, it previews the current buffer.
-
+Action Shows message in statusbar (for script purposes).
\end_layout
\begin_layout Description
-Syntax master-buffer-view
+Syntax message <STRING>
\end_layout
\begin_layout Description
-Origin Tommaso, 20 Sep 2007
+Origin Lgb, 8 Apr 2001
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_LANGUAGE
+meta-prefix
\end_layout
\begin_layout Description
-Action Set language of the current document.
-
+Action Simulate halting Meta key (Alt key on PCs).
\end_layout
\begin_layout Description
-Syntax buffer-language <LANG>
+Notion Used for buffer edition not for GUI control.
\end_layout
\begin_layout Description
-Params <LANG>: language name.
- See lib/languages for list.
-
+Syntax meta-prefix
\end_layout
-\begin_layout Description
-Origin leeming, 30 Mar 2004
+\begin_layout Subsection*
+preferences-save
\end_layout
-\begin_layout Subsection*
-LFUN_BUFFER_SAVE_AS_DEFAULT
+\begin_layout Description
+Action Save user preferences.
\end_layout
\begin_layout Description
-Action Save the current document settings as default.
-
+Syntax preferences-save
\end_layout
\begin_layout Description
-Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
-
+Origin Lgb, 27 Nov 1999
+\end_layout
+
+\begin_layout Subsection*
+reconfigure
\end_layout
\begin_layout Description
-Syntax buffer-save-as-default [<ARGS>]
+Action Reconfigure the automatic settings.
\end_layout
\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.
-
+Syntax reconfigure
\end_layout
\begin_layout Description
-Origin leeming, 30 Mar 2004
+Origin Asger, 14 Feb 1997
\end_layout
\begin_layout Subsection*
-LFUN_BUFFER_PARAMS_APPLY
+search-ignore
\end_layout
\begin_layout Description
-Action Apply the given settings to the current document.
-
+Action Enables/disables searching for features in findadv
\end_layout
\begin_layout Description
-Syntax buffer-params-apply [<ARGS>]
+Syntax search-ignore <type> <value>
\end_layout
\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.
-
+Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
\end_layout
-\begin_layout Description
-Origin leeming, 30 Mar 2004
+\begin_layout Subsection*
+server-get-filename
\end_layout
-\begin_layout Subsection*
-LFUN_FILE_INSERT
+\begin_layout Description
+Action Returns path and file name of the currently edited document.
\end_layout
\begin_layout Description
-Action Inserts another LyX file.
-
+Syntax server-get-filename
+\end_layout
+
+\begin_layout Subsection*
+server-get-layout
\end_layout
\begin_layout Description
-Syntax file-insert [<FILE>]
+Action Returns the current layout (that is environment) name on the cursor position.
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be inserted.
-
+Syntax server-get-layout
\end_layout
\begin_layout Subsection*
-LFUN_FILE_INSERT_PLAINTEXT
+server-get-statistics
\end_layout
\begin_layout Description
-Action Inserts plain text file.
-
+Action Returns the statistics (number of words and characters) in the document or in the given selection.
\end_layout
\begin_layout Description
-Syntax file-insert-plaintext [<FILE>]
+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
-Params <FILE>: Filename to be inserted.
-
+Syntax server-get-statistics [<TYPE>]
\end_layout
\begin_layout Description
-Origin CFO-G, 19 Nov 1997
-\end_layout
+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
-\begin_layout Subsection*
-LFUN_FILE_INSERT_PLAINTEXT_PARA
+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
-Action Inserts plain text file as paragraph (i.e.
- join lines).
-
+Origin brokenclock, Oct 10 2014
\end_layout
-\begin_layout Description
-Syntax file-insert-plaintext-para [<FILE>]
+\begin_layout Subsection*
+server-get-xy
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be inserted.
-
+Action Returns the coordinates of cursor position in the editing area.
\end_layout
\begin_layout Description
-Origin Levon, 14 Feb 2001
+Syntax server-get-xy
\end_layout
\begin_layout Subsection*
-LFUN_FILE_OPEN
+server-goto-file-row
\end_layout
\begin_layout Description
-Action Open LyX document.
-
+Action Sets the cursor position in LyX based on the row number of generated TeX file.
\end_layout
\begin_layout Description
-Syntax file-open [<FILE>]
+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).
\end_layout
\begin_layout Description
-Params <FILE>: Filename to be opened.
-
-\end_layout
-
-\begin_layout Subsection*
-LFUN_CALL
+Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
\end_layout
\begin_layout Description
-Action Executes a command defined in a .def file.
-
-\end_layout
+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
-\begin_layout Description
-Notion The definitions are by default read from lib/commands/default.def.
-
+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
- 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.
-
+.ext: extensions will be automatically replaced by .lyx.
\begin_inset Newline newline
\end_inset
- 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.
-
+<ROW_NUMBER> The row number of the LaTeX file to which to go.
\end_layout
\begin_layout Description
-Syntax call <NAME>
-\end_layout
+Sample server-goto-file-row /home/user/example.lyx 41
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Params <NAME>: Name of the command that must be called.
-
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
-Origin broider, 2 Oct 2007
+Origin Edmar, 23 Dec 1998
\end_layout
\begin_layout Subsection*
-LFUN_META_PREFIX
+server-notify
\end_layout
\begin_layout Description
-Action Simulate halting Meta key (Alt key on PCs).
-
+Action Sends notify message about the last key-sequence to client.
\end_layout
\begin_layout Description
-Notion Used for buffer editation not for GUI control.
-
+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
-Syntax meta-prefix
+Syntax server-notify
\end_layout
\begin_layout Subsection*
-LFUN_CANCEL
+server-set-xy
\end_layout
\begin_layout Description
-Action Cancels sequence prepared by LFUN_META_PREFIX .
-
+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
-Syntax cancel
+Syntax server-set-xy <X> <Y>
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_EXECUTE
+set-color
\end_layout
\begin_layout Description
-Action Opens the minibuffer toolbar so that the user can type in there.
-
+Action Set the given LyX color to the color defined by the X11 name given.
\end_layout
\begin_layout Description
-Notion Usually bound to M-x shortcut.
-
+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
+Syntax set-color <LYX_NAME> <X11_NAME>
\end_layout
\begin_layout Description
-Syntax command-execute
+Origin SLior, 11 Jun 2000
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_PREFIX
+statistics
\end_layout
\begin_layout Description
-Action Return the current key sequence and available options as a string.
-
+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
-Notion No options are added if no current map exists.
-
-\begin_inset Newline newline
-\end_inset
-
- This is probably usable only with connection to lyxserver.
-
+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 command-prefix
+Syntax statistics
\end_layout
-\begin_layout Subsection*
-LFUN_COMMAND_SEQUENCE
+\begin_layout Description
+Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
\end_layout
-\begin_layout Description
-Action Run more commands (LFUN and its parameters) in a sequence.
-
+\begin_layout Subsection*
+vc-check-in
\end_layout
\begin_layout Description
-Syntax command-sequence <CMDS>
+Action Checks-in/commits the changes of the registered file to the repository.
\end_layout
\begin_layout Description
-Params <CMDS>: Sequence of commands separated by semicolons.
-
+Notion In RCS case this also unlocks the file.
\end_layout
\begin_layout Description
-Sample command-sequence cut; ert-insert; self-insert ; paste; self-insert
- {}; inset-toggle;
+Syntax vc-check-in
\end_layout
\begin_layout Description
-Origin Andre, 11 Nov 1999
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMMAND_ALTERNATIVES
+vc-check-out
\end_layout
\begin_layout Description
-Action Runs the first listed command that is enabled.
-
+Action Checks-out the document for edit (and locks it in some cases).
\end_layout
\begin_layout Description
-Notion This can be used to bind multiple functions to a single key, and
- then which one is used will depend upon the context.
-
+Syntax vc-check-out
\end_layout
\begin_layout Description
-Syntax command-alternatives <CMDS>
+Origin Lgb, 1 Jul 1997
\end_layout
-\begin_layout Description
-Params <CMDS>: Sequence of commands separated by semicolons.
-
+\begin_layout Subsection*
+vc-command
\end_layout
\begin_layout Description
-Sample command-alternatives completion-accept;cell-forward
+Action Executes external command. This command is intended to support additional VCS commands.
\end_layout
\begin_layout Description
-Origin rgh, 24 September 2008
-\end_layout
-
-\begin_layout Subsection*
-LFUN_MESSAGE
+Syntax vc-command <FLAG> <PATH> <COMMAND>
\end_layout
\begin_layout Description
-Action Shows message in statusbar (for script purposes).
-
+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.
\end_layout
\begin_layout Description
-Syntax message <STRING>
+Sample vc-command DR $$p "svn up"
\end_layout
\begin_layout Description
-Origin Lgb, 8 Apr 2001
+Origin sanda, 13 Jan 2009
\end_layout
\begin_layout Subsection*
-LFUN_PREFERENCES_SAVE
+vc-compare
\end_layout
\begin_layout Description
-Action Save user preferences.
-
+Action Compares two revisions of the same file under version control.
\end_layout
\begin_layout Description
-Syntax preferences-save
+Syntax vc-compare [<REV1>] [<REV2>]
\end_layout
\begin_layout Description
-Origin Lgb, 27 Nov 1999
-\end_layout
+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
-\begin_layout Subsection*
-LFUN_RECONFIGURE
-\end_layout
+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
-\begin_layout Description
-Action Reconfigure the automatic settings.
-
+<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.
\end_layout
\begin_layout Description
-Syntax reconfigure
+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
\end_layout
\begin_layout Description
-Origin Asger, 14 Feb 1997
+Origin sanda, 12 Feb 2010
\end_layout
\begin_layout Subsection*
-LFUN_LYXRC_APPLY
+vc-copy
\end_layout
\begin_layout Description
-Action Apply the given settings to user preferences.
-
+Action Copies the document to another name.
\end_layout
\begin_layout Description
-Syntax lyxrc-apply <SETTINGS>
+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
-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*
-LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
+Syntax vc-copy <FILENAME>
\end_layout
\begin_layout Description
-Action Determine whether keep cursor inside the editing window regardless
- the scrollbar movement.
-
-\end_layout
+Params <FILENAME>: New name of the document.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax toggle-cursor-follows-scrollbar
+A file dialog is opened if no filename is given.
\end_layout
\begin_layout Description
-Origin ARRae, 2 Dec 1997
+Origin gb, 05 Feb 2013
\end_layout
\begin_layout Subsection*
-LFUN_SET_COLOR
+vc-locking-toggle
\end_layout
\begin_layout Description
-Action Set the given LyX color to the color defined by the X11 name given.
-
+Action Toggles the locking property of the edited file.
\end_layout
\begin_layout Description
-Notion A new color entry is created if the color is unknown.
- Color names can be stored as a part of user settings.
-
+Notion This is currently implemented only for SVN.
\end_layout
\begin_layout Description
-Syntax set-color <LYX_NAME> <X11_NAME>
+Syntax vc-locking-toggle
\end_layout
\begin_layout Description
-Origin SLior, 11 Jun 2000
+Origin sanda, 25 Jun 2009
\end_layout
\begin_layout Subsection*
-LFUN_STATISTICS
+vc-register
\end_layout
\begin_layout Description
-Action Count the statistics (number of words and characters) in the document
- or in the given selection.
-
+Action Register the document as an file inside version control system.
\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.
-
+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
\begin_layout Description
-Syntax statistics
+Syntax vc-register
\end_layout
\begin_layout Description
-Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_INLINE
+vc-rename
\end_layout
\begin_layout Description
-Action Show the inline completion at the cursor position.
-
+Action Renames the document to another name.
\end_layout
\begin_layout Description
-Syntax completion-inline
+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
\begin_layout Description
-Origin sts, Feb 19 2008
-\end_layout
-
-\begin_layout Subsection*
-LFUN_COMPLETION_POPUP
+Syntax vc-rename <FILENAME>
\end_layout
\begin_layout Description
-Action Show the completion popup at the cursor position.
-
-\end_layout
+Params <FILENAME>: New name of the document.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-Syntax completion-popup
+A file dialog is opened if no filename is given.
\end_layout
\begin_layout Description
-Origin sts, Feb 19 2008
+Origin gb, 05 Feb 2013
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_COMPLETE
+vc-repo-update
\end_layout
\begin_layout Description
-Action Try to complete the word or command at the cursor position.
-
+Action Update the local archive directory in which resides the current document with the remote repository.
\end_layout
\begin_layout Description
-Syntax complete
+Syntax vc-repo-update
\end_layout
\begin_layout Description
-Origin sts, Feb 19 2008
+Origin sanda, 16 Oct 2009
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_CANCEL
+vc-revert
\end_layout
\begin_layout Description
-Action Try to cancel completion, either the popup or the inline completion
-
+Action Reverts the document to the last check-in/commit in VCS.
\end_layout
\begin_layout Description
-Syntax completion-cancel
+Syntax vc-revert
\end_layout
\begin_layout Description
-Origin sts, Sep 07 2008
+Origin Lgb, 1 Jul 1997
\end_layout
\begin_layout Subsection*
-LFUN_COMPLETION_ACCEPT
+vc-undo-last
\end_layout
\begin_layout Description
-Action Accept suggested completion.
-
+Action Undo last check-in.
\end_layout
\begin_layout Description
-Syntax completion-accept
+Notion This is currently implemented only for RCS.
\end_layout
\begin_layout Description
-Origin sanda, Sep 08 2008
+Syntax vc-check-out
\end_layout
-\begin_layout Subsection*
-LFUN_BRANCH_ACTIVATE
+\begin_layout Description
+Origin Lgb, 1 Jul 1997
\end_layout
-\begin_layout Description
-Action Activate the branch
+\begin_layout Section
+Hidden Functions (not listed for configuration)
\end_layout
-\begin_layout Description
-Syntax branch-activate <BRANCH>
+\begin_layout Subsection*
+command-prefix
\end_layout
\begin_layout Description
-Params <BRANCH>: The branch to activate
+Action Return the current key sequence and available options as a string.
\end_layout
\begin_layout Description
-Sample lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
+Notion No options are added if no current map exists.
\begin_inset Newline newline
\end_inset
-could be used to export a pdf with the answers branch includedwithout one's
- having to open LyX and activate the branch manually.
+This is probably usable only with connection to lyxserver.
\end_layout
\begin_layout Description
-Origin rgh, 27 May 2008
+Syntax command-prefix
\end_layout
\begin_layout Subsection*
-LFUN_BRANCH_ACTIVATE
+lyx-activate
+\end_layout
+
+\begin_layout Description
+Action Activates the LyX window.
+\end_layout
+
+\begin_layout Description
+Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
+\end_layout
+
+\begin_layout Description
+Syntax lyx-activate
\end_layout
\begin_layout Description
-Action De-activate the branch
+Origin skostysh, 4 Aug 2016
+\end_layout
+
+\begin_layout Subsection*
+self-insert
\end_layout
\begin_layout Description
-Syntax branch-deactivate <BRANCH>
+Action Inserts the given string (accordingly to the correct keymap).
\end_layout
\begin_layout Description
-Params <BRANCH>: The branch to deactivate
+Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
\end_layout
\begin_layout Description
-Origin rgh, 27 May 2008
+Syntax self-insert <STRING>
\end_layout
\end_body
projects / lyx.git / blobdiff