X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=d95c0b30be6980d8e510aa6cd1dca37c2c05a9bf;hb=9b3daed4fadfef5a08376ae286211ec5543a0ab8;hp=f271dd473dd707fc12d8621c3e9c808688285704;hpb=e621229ee392b957d5862f216e02be588c43a3cf;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index f271dd473d..d95c0b30be 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -1,7 +1,9 @@ -# gen_lfuns.py generated this file. For more info see http://www.lyx.org/ -\lyxformat 474 +#LyX 2.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 541 \begin_document \begin_header +\save_transient_properties true +\origin /systemlyxdir/doc/ \textclass article \begin_preamble \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:} @@ -15,20 +17,28 @@ \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 \fontencoding global -\font_roman default -\font_sans default -\font_typewriter default -\font_math auto +\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 +\use_dash_ligatures true \graphics default \default_output_format default \output_sync 0 @@ -70,7 +80,8 @@ \tocdepth 3 \paragraph_separation indent \paragraph_indentation default -\quotes_language english +\is_math_indent 0 +\quotes_style english \papercolumns 1 \papersides 1 \paperpagestyle default @@ -84,1754 +95,1662 @@ \begin_body \begin_layout Title -LyX Functions (LFUNs) +\SpecialChar LyX + Functions (LFUNs) \end_layout \begin_layout Author -The LyX Team +The \SpecialChar LyX + Team \end_layout -\begin_layout Date -2014-02-10 +\begin_layout Section* +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 -\end_layout -\begin_layout Description -Action Adds an acute accent to the next character typed. + +\begin_layout Standard +In the following, all LFUNs are listed, categorized by function. \end_layout -\begin_layout Description -Syntax accent-acute + +\begin_layout Section +Layout Functions (Font, Layout and Textclass related) \end_layout \begin_layout Subsection* -LFUN_ACCENT_BREVE -\end_layout -\begin_layout Description -Action Adds a breve accent to the next character typed. +drop-layouts-choice \end_layout + \begin_layout Description -Syntax accent-breve +Action Displays list of layout choices. \end_layout -\begin_layout Subsection* -LFUN_ACCENT_CARON -\end_layout \begin_layout Description -Action Adds a caron to the next character typed. +Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. \end_layout + \begin_layout Description -Syntax accent-caron +Syntax drop-layouts-choice \end_layout \begin_layout Subsection* -LFUN_ACCENT_CEDILLA +environment-split \end_layout + \begin_layout Description -Action Adds a cedilla to the next character typed. +Action Splits the current environment with a Separator. \end_layout + \begin_layout Description -Syntax accent-cedilla +Syntax environment-split [outer] \end_layout -\begin_layout Subsection* -LFUN_ACCENT_CIRCLE -\end_layout \begin_layout Description -Action Adds a circle accent to the next character typed. +Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. \end_layout + \begin_layout Description -Syntax accent-circle +Origin spitz, 23 Dec 2012 \end_layout \begin_layout Subsection* -LFUN_ACCENT_CIRCUMFLEX +font-bold \end_layout + \begin_layout Description -Action Adds a circumflex to the next character typed. +Action Toggles the bold font (selection-wise) using mathbf in math. \end_layout + \begin_layout Description -Syntax accent-circumflex +Syntax font-bold \end_layout \begin_layout Subsection* -LFUN_ACCENT_DOT +font-boldsymbol \end_layout + \begin_layout Description -Action Adds a dot accent to the next character typed. +Action Toggles the bold font (selection-wise) using boldsymbol in math. \end_layout + \begin_layout Description -Syntax accent-dot +Syntax font-boldsymbol \end_layout \begin_layout Subsection* -LFUN_ACCENT_GRAVE -\end_layout -\begin_layout Description -Action Adds a grave accent to the next character typed. +font-crossout \end_layout + \begin_layout Description -Syntax accent-grave +Action Toggles xout (cross-through) in the font (selection-wise). \end_layout -\begin_layout Subsection* -LFUN_ACCENT_HUNGARIAN_UMLAUT -\end_layout \begin_layout Description -Action Adds a Hungarian umlaut to the next character typed. +Syntax font-crossout \end_layout + \begin_layout Description -Syntax accent-grave +Origin uwestoehr, 4 April 2017 \end_layout \begin_layout Subsection* -LFUN_ACCENT_MACRON +font-default \end_layout + \begin_layout Description -Action Adds a macron 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-macron +Syntax font-default \end_layout \begin_layout Subsection* -LFUN_ACCENT_OGONEK +font-emph \end_layout + \begin_layout Description -Action Adds an ogonek accent to the next character typed. +Action Toggles the emphasis font style (selection-wise). \end_layout + \begin_layout Description -Syntax accent-ogonek +Syntax font-emph \end_layout \begin_layout Subsection* -LFUN_ACCENT_TIE +font-frak \end_layout + \begin_layout Description -Action Adds a tie over the next two character typed. +Action Toggles Fraktur family font (math-mode, selection-wise). \end_layout + \begin_layout Description -Notion The following char will finish the tie. +Syntax font-frak \end_layout + \begin_layout Description -Syntax accent-tie +Origin vermeer, 10 Jan 2002 \end_layout \begin_layout Subsection* -LFUN_ACCENT_TILDE +font-ital \end_layout + \begin_layout Description -Action Adds a tilde over the next character typed. +Action Toggles Italics font shape (math-mode, selection-wise). \end_layout + \begin_layout Description -Syntax accent-tilde +Syntax font-ital +\end_layout + +\begin_layout Description +Origin vermeer, 10 Jan 2002 \end_layout \begin_layout Subsection* -LFUN_ACCENT_UMLAUT +font-noun \end_layout + \begin_layout Description -Action Adds an umlaut over the next character typed. +Action Toggles Noun text style font (selection-wise). \end_layout + \begin_layout Description -Syntax accent-umlaut +Syntax font-noun \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERBAR +font-roman \end_layout + \begin_layout Description -Action Adds a bar under the next character typed. +Action Toggles Roman family font (selection-wise). \end_layout + \begin_layout Description -Syntax accent-underbar +Syntax font-roman \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERDOT +font-sans \end_layout + \begin_layout Description -Action Adds a dot under the next character typed. +Action Toggles Sans Serif family font (selection-wise). \end_layout + \begin_layout Description -Syntax accent-underdot +Syntax font-sans \end_layout \begin_layout Subsection* -LFUN_ALL_CHANGES_ACCEPT +font-size \end_layout + \begin_layout Description -Action Accepts all tracked changes in the document. +Action Sets font size according to lyx format string. \end_layout + \begin_layout Description -Syntax all-changes-accept +Syntax font-size \end_layout + \begin_layout Description -Origin Levon, 16 Oct 2002 +Params : 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_ALL_CHANGES_REJECT -\end_layout -\begin_layout Description -Action Rejects all tracked changes in the document. -\end_layout -\begin_layout Description -Notion Reject does not work recursively; the user may have to repeat the operation. +font-state \end_layout + \begin_layout Description -Syntax all-changes-reject +Action Returns the info about the current font. \end_layout + \begin_layout Description -Origin Levon, 16 Oct 2002 +Syntax font-state \end_layout \begin_layout Subsection* -LFUN_APPENDIX +font-strikeout \end_layout + \begin_layout Description -Action Start (or remove) Appendix on the given cursor position. +Action Toggles strikeout (strike-through) in the font (selection-wise). \end_layout + \begin_layout Description -Syntax appendix +Syntax font-strikeout \end_layout + \begin_layout Description -Origin ettrich, 5 May 1998 +Origin sanda, 3 May 2009 \end_layout \begin_layout Subsection* -LFUN_ARGUMENT_INSERT +font-typewriter \end_layout + \begin_layout Description -Action Inserts an argument (short title) inset. +Action Toggles the typewriter family font (selection-wise). \end_layout + \begin_layout Description -Syntax argument-insert +Syntax font-typewriter +\end_layout + +\begin_layout Subsection* +font-underline \end_layout + \begin_layout Description -Params : see layout declarations +Action Toggles underline in the font (selection-wise). \end_layout + \begin_layout Description -Origin vermeer, 12 Aug 2002 +Syntax font-underline \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_ADD -\end_layout -\begin_layout Description -Action Adds database, which will be used for bibtex citations. +font-underunderline \end_layout + \begin_layout Description -Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. +Action Toggles double underline in the font (selection-wise). \end_layout + \begin_layout Description -Syntax bibtex-database-add +Syntax font-underunderline \end_layout + \begin_layout Description -Origin Ale, 30 May 1997 +Origin sanda, 5 May 2009 \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_DEL -\end_layout -\begin_layout Description -Action Adds database, which will be used for bibtex citations. +font-underwave \end_layout + \begin_layout Description -Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. +Action Toggles wavy underline in the font (selection-wise). \end_layout + \begin_layout Description -Syntax bibtex-database-del +Syntax font-underwave \end_layout + \begin_layout Description -Origin Ale, 30 May 1997 +Origin sanda, 5 May 2009 \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_CLEAR +layout \end_layout + \begin_layout Description -Action Clears the list of saved bookmarks. +Action Sets the layout (that is, environment) for the current paragraph. \end_layout + \begin_layout Description -Syntax bookmark-clear +Syntax layout \end_layout + \begin_layout Description -Origin bpeng, 31 October 2006 +Params : the layout to use \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_GOTO +layout-module-add \end_layout + \begin_layout Description -Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file. +Action Adds a module. \end_layout -\begin_layout Description -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. +\begin_layout Description +Notion Adds a module to the list of included modules for the current buffer. \end_layout + \begin_layout Description -Syntax bookmark-goto +Syntax layout-module-add \end_layout + \begin_layout Description -Params : the number of the bookmark to restore. +Params : the module to be added \end_layout + \begin_layout Description -Origin Dekel, 27 January 2001 +Origin rgh, 25 August 2007 \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_SAVE -\end_layout -\begin_layout Description -Action Save a bookmark. +layout-modules-clear \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. +Action Clears the module list. \end_layout + \begin_layout Description -Syntax bookmark-save +Notion Clears the list of included modules for the current buffer. \end_layout + \begin_layout Description -Params : the number of the bookmark to save. +Syntax layout-modules-clear \end_layout + \begin_layout Description -Origin Dekel, 27 January 2001 +Origin rgh, 25 August 2007 \end_layout \begin_layout Subsection* -LFUN_BOX_INSERT -\end_layout -\begin_layout Description -Action Inserts Box inset. +layout-paragraph \end_layout + \begin_layout Description -Syntax box-insert [] +Action Launches the paragraph settings dialog. \end_layout -\begin_layout Description -Params : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox -\begin_inset Newline newline -\end_inset -Framed is the default one. -\end_layout \begin_layout Description -Origin vermeer, 7 Oct 2003 +Syntax layout-paragraph \end_layout \begin_layout Subsection* -LFUN_BRANCHES_RENAME +layout-reload \end_layout + \begin_layout Description -Action Rename all branches of a given name in a document. +Action Reloads layout information. \end_layout + \begin_layout Description -Syntax branches-rename +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 -Params : Current name of the branch to be renamed : New name of the branch +Syntax layout-reload \end_layout + \begin_layout Description -Origin spitz, 9 Jul 2009 +Origin rgh, 3 September 2007 \end_layout \begin_layout Subsection* -LFUN_BRANCH_ACTIVATE -\end_layout -\begin_layout Description -Action Activate the branch. +layout-tabular \end_layout + \begin_layout Description -Syntax branch-activate +Action Launches the tabular settings dialog. \end_layout + \begin_layout Description -Params : The branch to activate +Syntax layout-tabular \end_layout -\begin_layout Description -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 rgh, 27 May 2008 +Origin Jug, 31 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_BRANCH_ADD +screen-font-update \end_layout + \begin_layout Description -Action Add a branch to the buffer's BranchList. +Action Update fonts and its metrics. \end_layout + \begin_layout Description -Syntax branch-add +Notion Automatically called after zoom, dpi, font names, or norm change. \end_layout + \begin_layout Description -Params : Name of the branch to add +Syntax screen-font-update \end_layout + \begin_layout Description -Origin spitz, 7 Jul 2009 +Origin ARRae, 13 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_BRANCH_ADD_INSERT -\end_layout -\begin_layout Description -Action Create new branch and directly put the branch inset into the document. +textclass-apply \end_layout + \begin_layout Description -Syntax branch-add-insert [] +Action Sets the text class for the current buffer. \end_layout + \begin_layout Description -Params : Branch name. If it is not specified, you will be asked. +Syntax textclass-apply \end_layout + \begin_layout Description -Origin sanda, 10 Jul 2009 +Params : the textclass to set. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* -LFUN_BRANCH_DEACTIVATE -\end_layout -\begin_layout Description -Action De-activate the branch. +textclass-load \end_layout + \begin_layout Description -Syntax branch-deactivate +Action Loads information for a textclass from disk. \end_layout + \begin_layout Description -Params : The branch to deactivate +Syntax textclass-load \end_layout + \begin_layout Description -Origin rgh, 27 May 2008 +Params : the textclass to load. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* -LFUN_BRANCH_INSERT +textstyle-apply \end_layout + \begin_layout Description -Action Inserts branch inset. +Action Toggle user-defined (=last-time used) text style. +\end_layout + +\begin_layout Description +Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. \end_layout + \begin_layout Description -Syntax branch-insert +Syntax textstyle-apply \end_layout + \begin_layout Description -Origin vermeer, 17 Aug 2003 +Origin leeming, 12 Mar 2003 \end_layout \begin_layout Subsection* -LFUN_BRANCH_MASTER_ACTIVATE -\end_layout -\begin_layout Description -Action Activate the branch in the master buffer. +textstyle-update \end_layout + \begin_layout Description -Syntax branch-master-activate +Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY. \end_layout + \begin_layout Description -Params : The branch to activate +Syntax textstyle-update \end_layout + \begin_layout Description -Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx +Params : specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall. \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. +Use lyx -dbg action for exact syntax of text-style dialog parameters. \end_layout + \begin_layout Description -Origin spitz, 30 Sep 2012 +Origin leeming, 12 Mar 2003 +\end_layout + +\begin_layout Section +Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.) \end_layout \begin_layout Subsection* -LFUN_BRANCH_MASTER_DEACTIVATE +accent-acute \end_layout + \begin_layout Description -Action De-activate the branch in the master buffer. +Action Adds an acute accent to the next character typed. \end_layout + \begin_layout Description -Syntax branch-master-deactivate +Syntax accent-acute +\end_layout + +\begin_layout Subsection* +accent-breve \end_layout + \begin_layout Description -Params : The branch to deactivate +Action Adds a breve accent to the next character typed. \end_layout + \begin_layout Description -Origin spitz, 30 Sep 2012 +Syntax accent-breve \end_layout \begin_layout Subsection* -LFUN_BUFFER_AUTO_SAVE -\end_layout -\begin_layout Description -Action Saves the current buffer to a temporary file. +accent-caron \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. +Action Adds a caron to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-auto-save +Syntax accent-caron \end_layout \begin_layout Subsection* -LFUN_BUFFER_BEGIN +accent-cedilla \end_layout + \begin_layout Description -Action Move the cursor to the beginning of the document. +Action Adds a cedilla to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-begin +Syntax accent-cedilla \end_layout \begin_layout Subsection* -LFUN_BUFFER_BEGIN_SELECT +accent-circle \end_layout + \begin_layout Description -Action Move the cursor to the beginning of the document adding the traversed text to the selection. +Action Adds a circle accent to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-begin-select +Syntax accent-circle \end_layout \begin_layout Subsection* -LFUN_BUFFER_CHILD_OPEN +accent-circumflex \end_layout + \begin_layout Description -Action Loads the given child document. +Action Adds a circumflex to the next character typed. \end_layout + \begin_layout Description -Notion The current document is treated as a parent. +Syntax accent-circumflex \end_layout -\begin_layout Description -Syntax buffer-child-open + +\begin_layout Subsection* +accent-dot \end_layout + \begin_layout Description -Params : Filename of the child. The directory of the parent is assumed by default. +Action Adds a dot accent to the next character typed. \end_layout + \begin_layout Description -Origin Ale, 28 May 1997 +Syntax accent-dot \end_layout \begin_layout Subsection* -LFUN_BUFFER_CHKTEX -\end_layout -\begin_layout Description -Action Runs chktex for the current document. +accent-grave \end_layout + \begin_layout Description -Syntax buffer-chktex +Action Adds a grave accent to the next character typed. \end_layout + \begin_layout Description -Origin Asger, 30 Oct 1997 +Syntax accent-grave \end_layout \begin_layout Subsection* -LFUN_BUFFER_CLOSE -\end_layout -\begin_layout Description -Action Closes the current buffer. +accent-hungarian-umlaut \end_layout + \begin_layout Description -Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified. +Action Adds a Hungarian umlaut to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-close +Syntax accent-grave \end_layout \begin_layout Subsection* -LFUN_BUFFER_CLOSE_ALL -\end_layout -\begin_layout Description -Action Closes all buffers. +accent-macron \end_layout + \begin_layout Description -Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified. +Action Adds a macron to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-close-all +Syntax accent-macron \end_layout \begin_layout Subsection* -LFUN_BUFFER_END +accent-ogonek \end_layout + \begin_layout Description -Action Move the cursor to the end of the document. +Action Adds an ogonek accent to the next character typed. \end_layout + \begin_layout Description -Syntax buffer-end +Syntax accent-ogonek \end_layout \begin_layout Subsection* -LFUN_BUFFER_END_SELECT +accent-perispomeni \end_layout + \begin_layout Description -Action Move the cursor to the end of the document adding the traversed text to the selection. +Action Adds a perispomeni (Greek circumflex) over the next character typed. \end_layout + \begin_layout Description -Syntax buffer-end-select +Syntax accent-perispomeni \end_layout \begin_layout Subsection* -LFUN_BUFFER_EXPORT +accent-tie \end_layout + \begin_layout Description -Action Exports the current buffer (document) to the given format. +Action Adds a tie over the next two character typed. \end_layout + \begin_layout Description -Syntax buffer-export [] +Notion The following char will finish the tie. \end_layout -\begin_layout Description -Params 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. 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 +Syntax accent-tie \end_layout \begin_layout Subsection* -LFUN_BUFFER_EXPORT_AS +accent-tilde \end_layout + \begin_layout Description -Action Opens a dialog for exporting the current buffer. +Action Adds a tilde over the next character typed. \end_layout + \begin_layout Description -Syntax buffer-export-as [] +Syntax accent-tilde \end_layout -\begin_layout Description -Params 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. + +\begin_layout Subsection* +accent-umlaut \end_layout + \begin_layout Description -Sample buffer-export-as pdf2 +Action Adds an umlaut over the next character typed. \end_layout + \begin_layout Description -Origin tommaso, 6 Oct 2011 +Syntax accent-umlaut \end_layout \begin_layout Subsection* -LFUN_BUFFER_EXPORT_CUSTOM +accent-underbar \end_layout + \begin_layout Description -Action Exports the current buffer (document) from the given format using the given command on it. +Action Adds a bar under the next character typed. \end_layout + \begin_layout Description -Syntax buffer-export-custom +Syntax accent-underbar \end_layout -\begin_layout Description -Params format to start from (LyX will care to produce such intermediate file). -\begin_inset Newline newline -\end_inset - this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file. +\begin_layout Subsection* +accent-underdot \end_layout + \begin_layout Description -Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps +Action Adds a dot under the next character typed. \end_layout + \begin_layout Description -Origin leeming, 27 Mar 2004 +Syntax accent-underdot \end_layout \begin_layout Subsection* -LFUN_BUFFER_FORALL +all-changes-accept \end_layout + \begin_layout Description -Action Applies a command to all non-hidden buffers. +Action Accepts all tracked changes in the document. \end_layout + \begin_layout Description -Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window. +Syntax all-changes-accept \end_layout + \begin_layout Description -Syntax buffer-forall +Origin Levon, 16 Oct 2002 \end_layout + +\begin_layout Subsection* +all-changes-reject +\end_layout + \begin_layout Description -Params : The command to be applied to the buffers. +Action Rejects all tracked changes in the document. \end_layout + \begin_layout Description -Sample Close all Notes in buffers: -\begin_inset Newline newline -\end_inset +Notion Reject does not work recursively; the user may have to repeat the operation. +\end_layout - buffer-forall inset-forall Note inset-toggle close -\begin_inset Newline newline -\end_inset +\begin_layout Description +Syntax all-changes-reject +\end_layout -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 scottkostyshak, 20 Jul 2012 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_BUFFER_IMPORT -\end_layout -\begin_layout Description -Action Import a given file as a lyx document. +appendix \end_layout + \begin_layout Description -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. +Action Start (or remove) Appendix on the given cursor position. \end_layout + \begin_layout Description -Syntax buffer-import [] +Syntax appendix \end_layout + \begin_layout Description -Origin Asger, 24 Jul 1998 +Origin ettrich, 5 May 1998 \end_layout \begin_layout Subsection* -LFUN_BUFFER_LANGUAGE +argument-insert \end_layout + \begin_layout Description -Action Set language of the current document. +Action Inserts an argument (short title) inset. \end_layout + \begin_layout Description -Syntax buffer-language +Syntax argument-insert \end_layout + \begin_layout Description -Params : language name. See lib/languages for list. +Params : see layout declarations \end_layout + \begin_layout Description -Origin leeming, 30 Mar 2004 +Origin vermeer, 12 Aug 2002 \end_layout \begin_layout Subsection* -LFUN_BUFFER_NEW +bibtex-database-add \end_layout + \begin_layout Description -Action Creates a new buffer (that is, document) and switches to it. +Action Adds database, which will be used for bibtex citations. \end_layout + \begin_layout Description -Notion Implicit path can be set in Preferences dialog. +Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout + \begin_layout Description -Syntax buffer-new [] +Syntax bibtex-database-add \end_layout + \begin_layout Description -Params : filename of created file with absolute path. +Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_BUFFER_NEW_TEMPLATE +bibtex-database-del \end_layout + \begin_layout Description -Action Creates a new buffer (that is, document) from a template. +Action Adds database, which will be used for bibtex citations. \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 Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout + \begin_layout Description -Syntax buffer-new-template [] +Syntax bibtex-database-del \end_layout + \begin_layout Description -Params : filename of created file with absolute path. +Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_BUFFER_NEXT +bookmark-clear \end_layout + \begin_layout Description -Action Switch to the next opened document. +Action Clears the list of saved bookmarks. \end_layout + \begin_layout Description -Notion Note that this does not necessarily mean next in tabbar (for full list see View menu). +Syntax bookmark-clear \end_layout + \begin_layout Description -Syntax buffer-next +Origin bpeng, 31 October 2006 \end_layout \begin_layout Subsection* -LFUN_BUFFER_PARAMS_APPLY +bookmark-goto \end_layout + \begin_layout Description -Action Apply the given settings to the current document. +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 buffer-params-apply [] +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 Description -Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. +Syntax bookmark-goto +\end_layout + +\begin_layout Description +Params : the number of the bookmark to restore. \end_layout + \begin_layout Description -Origin leeming, 30 Mar 2004 +Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_BUFFER_PREVIOUS +bookmark-save \end_layout + \begin_layout Description -Action Switch to the previous opened document. +Action Save a bookmark. \end_layout + \begin_layout Description -Syntax buffer-previous +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_BUFFER_PRINT +\begin_layout Description +Syntax bookmark-save \end_layout + \begin_layout Description -Action Prints the current document. +Params : the number of the bookmark to save. \end_layout + \begin_layout Description -Notion Many settings can be given via the preferences dialog. +Origin Dekel, 27 January 2001 +\end_layout + +\begin_layout Subsection* +box-insert \end_layout + \begin_layout Description -Syntax buffer-print +Action Inserts Box inset. \end_layout + \begin_layout Description -Params is either "printer" or "file". -\begin_inset Newline newline -\end_inset +Syntax box-insert [] +\end_layout - is either "default" or file name or printer name. +\begin_layout Description +Params : Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \begin_inset Newline newline \end_inset - command ensuring the printing job. -\end_layout -\begin_layout Description -Sample buffer-print file "/trash/newfile1.ps" "dvips" +Framed is the default one. \end_layout + \begin_layout Description -Origin leeming, 28 Mar 2004 +Origin vermeer, 7 Oct 2003 \end_layout \begin_layout Subsection* -LFUN_BUFFER_RELOAD +branch-insert \end_layout + \begin_layout Description -Action Reverts opened document. +Action Inserts branch inset. \end_layout + \begin_layout Description -Syntax buffer-reload +Syntax branch-insert \end_layout + \begin_layout Description -Origin Asger, 2 Feb 1997 +Origin vermeer, 17 Aug 2003 \end_layout \begin_layout Subsection* -LFUN_BUFFER_SAVE_AS_DEFAULT +buffer-begin \end_layout + \begin_layout Description -Action Save the current document settings as default. +Action Move the cursor to the beginning of the document. \end_layout + \begin_layout Description -Notion The file will will be saved into ~/.lyx/templates/defaults.lyx . +Syntax buffer-begin \end_layout -\begin_layout Description -Syntax buffer-save-as-default [] + +\begin_layout Subsection* +buffer-begin-select \end_layout + \begin_layout Description -Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. +Action Move the cursor to the beginning of the document adding the traversed text to the selection. \end_layout + \begin_layout Description -Origin leeming, 30 Mar 2004 +Syntax buffer-begin-select \end_layout \begin_layout Subsection* -LFUN_BUFFER_SWITCH -\end_layout -\begin_layout Description -Action Display and switch to the given buffer. +buffer-end \end_layout + \begin_layout Description -Syntax buffer-switch +Action Move the cursor to the end of the document. \end_layout + \begin_layout Description -Params : path and filename of already opened (but possibly hidden) document which is to be shown. +Syntax buffer-end \end_layout \begin_layout Subsection* -LFUN_BUFFER_TOGGLE_COMPRESSION -\end_layout -\begin_layout Description -Action Toggles compression of the current document on/off. +buffer-end-select \end_layout + \begin_layout Description -Syntax buffer-toggle-compression +Action Move the cursor to the end of the document adding the traversed text to the selection. \end_layout + \begin_layout Description -Origin bpeng, 27 Apr 2006 +Syntax buffer-end-select \end_layout \begin_layout Subsection* -LFUN_BUFFER_TOGGLE_OUTPUT_SYNC -\end_layout -\begin_layout Description -Action Toggles including of resources for forward/reverse search of the given document. +caption-insert \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. +Action Inserts a caption inset. \end_layout + \begin_layout Description -Syntax buffer-toggle-output-sync +Syntax caption-insert \end_layout + \begin_layout Description -Origin sanda, 25 May 2010 +Origin Lgb, 18 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_BUFFER_TOGGLE_READ_ONLY -\end_layout -\begin_layout Description -Action Toggle editing mode of the current document between read/write and read-only. +cell-backward \end_layout + \begin_layout Description -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. +Action Moves the cursor to the previous cell inside the table. \end_layout + \begin_layout Description -Syntax buffer-toggle-read-only +Syntax cell-backward \end_layout + \begin_layout Description -Origin Lgb, 27 May 1997 +Origin Jug, 22 May 2000 \end_layout \begin_layout Subsection* -LFUN_BUFFER_UPDATE +cell-forward \end_layout + \begin_layout Description -Action Exports the current document and put the result into the temporary directory. +Action Moves the cursor to the next cell inside the table. \end_layout + \begin_layout Description -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). +Syntax cell-forward +\end_layout + +\begin_layout Subsection* +cell-split \end_layout + \begin_layout Description -Syntax buffer-update [] +Action Splits cell and shifts right part to the next cell (inside the math grid). \end_layout + \begin_layout Description -Params : 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. +Syntax cell-split \end_layout + \begin_layout Description -Origin Dekel, 5 Aug 2000 +Origin Ale, 15 May 1997 \end_layout \begin_layout Subsection* -LFUN_BUFFER_VIEW -\end_layout -\begin_layout Description -Action Displays current buffer in chosen format. +change-accept \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. +Action Accepts tracked change inside the selection. \end_layout + \begin_layout Description -Syntax buffer-view [] +Syntax change-accept \end_layout + \begin_layout Description -Params : 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. +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_BUFFER_WRITE +change-next \end_layout + \begin_layout Description -Action Saves the current buffer. +Action Moves the cursor to the position of the next change of the change tracking records. \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 change-next \end_layout + \begin_layout Description -Syntax buffer-write +Origin schmitt, 4 Oct 2006 \end_layout \begin_layout Subsection* -LFUN_BUFFER_WRITE_ALL +change-previous \end_layout + \begin_layout Description -Action Save all changed documents. +Action Moves the cursor to the position of the previous change of the change tracking records. \end_layout + \begin_layout Description -Syntax buffer-write-all +Syntax change-previous \end_layout + \begin_layout Description -Origin rgh, gpothier 6 Aug 2007 +Origin vfr, 4 Apr 2009 \end_layout \begin_layout Subsection* -LFUN_BUFFER_WRITE_AS +change-reject \end_layout + \begin_layout Description -Action Rename and save current buffer. +Action Rejects tracked change inside the selection. \end_layout + \begin_layout Description -Syntax buffer-write-as +Syntax change-reject \end_layout + \begin_layout Description -Params : New name of the buffer/file. A relative path is with respect to the original location of the buffer/file. +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_BUFFER_ZOOM_IN -\end_layout -\begin_layout Description -Action Increases the zoom of the screen fonts. +changes-merge \end_layout + \begin_layout Description -Syntax buffer-zoom-in [] +Action Open change tracking dialog for merging and moves the cursor to the position of the next change. \end_layout + \begin_layout Description -Params : The zoom in %, the default is 20. +Syntax changes-merge \end_layout + \begin_layout Description -Origin vfr, 30 Mar 2009 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_BUFFER_ZOOM_OUT -\end_layout -\begin_layout Description -Action Decreases the zoom of the screen fonts. -\end_layout -\begin_layout Description -Syntax buffer-zoom-out [] -\end_layout -\begin_layout Description -Params : The zoom in %, the default is 20. +changes-output \end_layout + \begin_layout Description -Origin vfr, 30 Mar 2009 +Action Toggles showing of change tracking in typeset output. \end_layout -\begin_layout Subsection* -LFUN_BUILD_PROGRAM -\end_layout \begin_layout Description -Action Generates the code (literate programming). +Syntax changes-output \end_layout -\begin_layout Description -Notion Latex file with extension -\backslash -literate_extension is generated. Then LyX invokes -\backslash -build_command (with a default of ``make'') to generate the code and -\backslash -build_error_filter to process the compilation error messages. -\begin_inset Newline newline -\end_inset - -In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with: -\begin_inset Newline newline -\end_inset - -\backslash -build_command "my_script my_arguments" -\begin_inset Newline newline -\end_inset - -The -\backslash -build_error_filter differs from the -\backslash -literate_error_filter only in that the former will identify error messages from your compiler. -\end_layout \begin_layout Description -Syntax build-program +Origin jspitzm, 21 Jan 2005 \end_layout \begin_layout Subsection* -LFUN_CALL -\end_layout -\begin_layout Description -Action Executes a command defined in a .def file. +changes-track \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 "" "" where is the name of the new command and 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/.png this is the way to assign an image to a complex command-sequence. -\end_layout -\begin_layout Description -Syntax call -\end_layout -\begin_layout Description -Params : Name of the command that must be called. -\end_layout \begin_layout Description -Origin broider, 2 Oct 2007 +Action Toggles change tracking to on/off. \end_layout -\begin_layout Subsection* -LFUN_CANCEL -\end_layout \begin_layout Description -Action Cancels sequence prepared by LFUN_META_PREFIX . +Syntax changes-track \end_layout + \begin_layout Description -Syntax cancel +Origin levon, 1 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_CAPTION_INSERT +char-backward \end_layout + \begin_layout Description -Action Inserts a caption inset. +Action Moves the cursor one position logically backwards. \end_layout + \begin_layout Description -Syntax caption-insert +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 -Origin Lgb, 18 Jul 2000 +Syntax char-backward \end_layout \begin_layout Subsection* -LFUN_CELL_BACKWARD -\end_layout -\begin_layout Description -Action Moves the cursor to the previous cell inside the table. -\end_layout -\begin_layout Description -Syntax cell-backward +char-backward-select \end_layout + \begin_layout Description -Origin Jug, 22 May 2000 +Action Moves the cursor one position logically backwards, adding traversed position to the selection. \end_layout -\begin_layout Subsection* -LFUN_CELL_FORWARD -\end_layout \begin_layout Description -Action Moves the cursor to the next cell inside the table. +Notion See also LFUN_CHAR_BACKWARD. \end_layout + \begin_layout Description -Syntax cell-forward +Syntax char-backward-select \end_layout \begin_layout Subsection* -LFUN_CELL_SPLIT +char-delete-backward \end_layout + \begin_layout Description -Action Splits cell and shifts right part to the next cell (inside the math grid). +Action Deletes one character in the backward direction (usually the "BackSpace" key). \end_layout + \begin_layout Description -Syntax cell-split +Syntax char-delete-backward [force] \end_layout + \begin_layout Description -Origin Ale, 15 May 1997 +Params force: Delete big insets, do not only select them. \end_layout \begin_layout Subsection* -LFUN_CHANGES_MERGE +char-delete-forward \end_layout + \begin_layout Description -Action Open change tracking dialog for merging and moves the cursor to the position of the next change. +Action Deletes one character in the backward direction (usually the "Delete" key). \end_layout + \begin_layout Description -Syntax changes-merge +Syntax char-delete-forward [force] \end_layout + \begin_layout Description -Origin Levon, 16 Oct 2002 +Params force: Delete big insets, do not only select them. \end_layout \begin_layout Subsection* -LFUN_CHANGES_OUTPUT +char-forward \end_layout + \begin_layout Description -Action Toggles showing of change tracking in typesetted output. +Action Moves the cursor one position logically forward. \end_layout + \begin_layout Description -Syntax changes-output +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 -Origin jspitzm, 21 Jan 2005 +Syntax char-forward \end_layout \begin_layout Subsection* -LFUN_CHANGES_TRACK +char-forward-select \end_layout + \begin_layout Description -Action Toggles change tracking to on/off. +Action Moves the cursor one position logically forward, adding traversed position to the selection. \end_layout + \begin_layout Description -Syntax changes-track +Notion See also LFUN_CHAR_FORWARD. \end_layout + \begin_layout Description -Origin levon, 1 Oct 2002 +Syntax char-forward-select \end_layout \begin_layout Subsection* -LFUN_CHANGE_ACCEPT +char-left \end_layout + \begin_layout Description -Action Accepts tracked change inside the selection. +Action Moves the cursor one position "to the left". \end_layout + \begin_layout Description -Syntax change-accept +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 Levon, 16 Oct 2002 +Syntax char-left \end_layout \begin_layout Subsection* -LFUN_CHANGE_NEXT +char-left-select \end_layout + \begin_layout Description -Action Moves the cursor to the position of the next change of the change tracking records. +Action Moves the cursor one position "to the left", adding traversed position to the selection. \end_layout + \begin_layout Description -Syntax change-next +Notion See also LFUN_CHAR_LEFT for exact details of the movement. \end_layout + \begin_layout Description -Origin schmitt, 4 Oct 2006 +Syntax char-left-select \end_layout \begin_layout Subsection* -LFUN_CHANGE_PREVIOUS +char-right \end_layout + \begin_layout Description -Action Moves the cursor to the position of the previous change of the change tracking records. +Action Moves the cursor one position "to the right". \end_layout + \begin_layout Description -Syntax change-previous +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 vfr, 4 Apr 2009 +Syntax char-right \end_layout \begin_layout Subsection* -LFUN_CHANGE_REJECT +char-right-select \end_layout + \begin_layout Description -Action Rejects tracked change inside the selection. +Action Moves the cursor one position "to the right", adding traversed position to the selection. \end_layout + \begin_layout Description -Syntax change-reject +Notion See also LFUN_CHAR_RIGHT for exact details of the movement. \end_layout + \begin_layout Description -Origin Levon, 16 Oct 2002 +Syntax char-right-select \end_layout \begin_layout Subsection* -LFUN_CHARS_TRANSPOSE +chars-transpose \end_layout + \begin_layout Description Action Transposes the character at the cursor with the one before it. \end_layout + \begin_layout Description Syntax chars-transpose \end_layout + \begin_layout Description Origin Lgb, 25 Apr 2001 \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD -\end_layout -\begin_layout Description -Action Moves the cursor one position logically backwards. -\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. +citation-insert \end_layout + \begin_layout Description -Syntax char-backward +Action Inserts citation from loaded citation database. \end_layout -\begin_layout Subsection* -LFUN_CHAR_BACKWARD_SELECT -\end_layout \begin_layout Description -Action Moves the cursor one position logically backwards, adding traversed position to the selection. +Syntax citation-insert [[|]] \end_layout + \begin_layout Description -Notion See also LFUN_CHAR_BACKWARD. +Params : Citation (shortcut listed in available citations). +\begin_inset Newline newline +\end_inset + +: text which should appear before citation. \end_layout + \begin_layout Description -Syntax char-backward-select +Origin AAS, 97-02-23 \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_BACKWARD +clipboard-paste \end_layout + \begin_layout Description -Action Deletes one character in the backward direction (usually the "BackSpace" key). +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 -Syntax char-delete-backward +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 Subsection* -LFUN_CHAR_DELETE_FORWARD +\begin_layout Description +Syntax clipboard-paste [] \end_layout + \begin_layout Description -Action Deletes one character in the backward direction (usually the "Delete" key). +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout + \begin_layout Description -Syntax char-delete-forward +Origin Georg, 10 Jul 2006 \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD +clipboard-paste-simple \end_layout + \begin_layout Description -Action Moves the cursor one position logically forward. +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 -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 clipboard-paste-simple [] \end_layout + \begin_layout Description -Syntax char-forward +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD_SELECT +command-execute \end_layout + \begin_layout Description -Action Moves the cursor one position logically forward, adding traversed position to the selection. +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 -Notion See also LFUN_CHAR_FORWARD. +Notion Usually bound to M-x shortcut. \end_layout + \begin_layout Description -Syntax char-forward-select +Syntax command-execute \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT -\end_layout -\begin_layout Description -Action Moves the cursor one position "to the left". -\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. -\end_layout -\begin_layout Description -Syntax char-left -\end_layout - -\begin_layout Subsection* -LFUN_CHAR_LEFT_SELECT -\end_layout -\begin_layout Description -Action Moves the cursor one position "to the left", adding traversed position to the selection. -\end_layout -\begin_layout Description -Notion See also LFUN_CHAR_LEFT for exact details of the movement. -\end_layout -\begin_layout Description -Syntax char-left-select -\end_layout - -\begin_layout Subsection* -LFUN_CHAR_RIGHT -\end_layout -\begin_layout Description -Action Moves the cursor one position "to the right". -\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. -\end_layout -\begin_layout Description -Syntax char-right -\end_layout - -\begin_layout Subsection* -LFUN_CHAR_RIGHT_SELECT -\end_layout -\begin_layout Description -Action Moves the cursor one position "to the right", adding traversed position to the selection. -\end_layout -\begin_layout Description -Notion See also LFUN_CHAR_RIGHT for exact details of the movement. -\end_layout -\begin_layout Description -Syntax char-right-select -\end_layout - -\begin_layout Subsection* -LFUN_CITATION_INSERT -\end_layout -\begin_layout Description -Action Inserts citation from loaded citation database. -\end_layout -\begin_layout Description -Syntax citation-insert [[|]] -\end_layout -\begin_layout Description -Params : Citation (shortcut listed in available citations). -\begin_inset Newline newline -\end_inset - -: text which should appear before citation. -\end_layout -\begin_layout Description -Origin AAS, 97-02-23 +complete \end_layout -\begin_layout Subsection* -LFUN_CLIPBOARD_PASTE -\end_layout -\begin_layout Description -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 colums if tha paste happens in a tabular inset. -\end_layout -\begin_layout Description -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 clipboard-paste [] -\end_layout -\begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". -\end_layout -\begin_layout Description -Origin Georg, 10 Jul 2006 -\end_layout - -\begin_layout Subsection* -LFUN_CLIPBOARD_PASTE_SIMPLE -\end_layout -\begin_layout Description -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 colums if the paste happens in a tabular inset. -\end_layout -\begin_layout Description -Syntax clipboard-paste-simple [] -\end_layout -\begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". -\end_layout - -\begin_layout Subsection* -LFUN_COMMAND_ALTERNATIVES -\end_layout -\begin_layout Description -Action Runs the first listed command that is enabled. -\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. -\end_layout -\begin_layout Description -Syntax command-alternatives -\end_layout -\begin_layout Description -Params : Sequence of commands separated by semicolons. -\end_layout -\begin_layout Description -Sample command-alternatives completion-accept;cell-forward -\end_layout -\begin_layout Description -Origin rgh, 24 September 2008 -\end_layout - -\begin_layout Subsection* -LFUN_COMMAND_EXECUTE -\end_layout -\begin_layout Description -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 -Notion Usually bound to M-x shortcut. -\end_layout \begin_layout Description -Syntax command-execute +Action Try to complete the word or command at the cursor position. \end_layout -\begin_layout Subsection* -LFUN_COMMAND_PREFIX -\end_layout \begin_layout Description -Action Return the current key sequence and available options as a string. +Syntax complete \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. -\end_layout \begin_layout Description -Syntax command-prefix +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COMMAND_SEQUENCE -\end_layout -\begin_layout Description -Action Run more commands (LFUN and its parameters) in a sequence. -\end_layout -\begin_layout Description -Syntax command-sequence -\end_layout -\begin_layout Description -Params : Sequence of commands separated by semicolons. -\end_layout -\begin_layout Description -Sample command-sequence cut; ert-insert; self-insert -\backslash -; paste; self-insert {}; inset-toggle; -\end_layout -\begin_layout Description -Origin Andre, 11 Nov 1999 +completion-accept \end_layout -\begin_layout Subsection* -LFUN_COMPLETION_ACCEPT -\end_layout \begin_layout Description Action Accept suggested completion. \end_layout + \begin_layout Description Syntax completion-accept \end_layout + \begin_layout Description Origin sanda, Sep 08 2008 \end_layout \begin_layout Subsection* -LFUN_COMPLETION_CANCEL +completion-cancel \end_layout + \begin_layout Description Action Try to cancel completion, either the popup or the inline completion. \end_layout + \begin_layout Description Syntax completion-cancel \end_layout + \begin_layout Description Origin sts, Sep 07 2008 \end_layout \begin_layout Subsection* -LFUN_COMPLETION_COMPLETE -\end_layout -\begin_layout Description -Action Try to complete the word or command at the cursor position. -\end_layout -\begin_layout Description -Syntax complete -\end_layout -\begin_layout Description -Origin sts, Feb 19 2008 +completion-inline \end_layout -\begin_layout Subsection* -LFUN_COMPLETION_INLINE -\end_layout \begin_layout Description Action Show the inline completion at the cursor position. \end_layout + \begin_layout Description Syntax completion-inline \end_layout + \begin_layout Description Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COMPLETION_POPUP +completion-popup \end_layout + \begin_layout Description Action Show the completion popup at the cursor position. \end_layout + \begin_layout Description Syntax completion-popup \end_layout + \begin_layout Description Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COPY +copy \end_layout + \begin_layout Description Action Copies the current selection to the clipboard. \end_layout + \begin_layout Description Syntax copy \end_layout \begin_layout Subsection* -LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE -\end_layout -\begin_layout Description -Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement. -\end_layout -\begin_layout Description -Syntax toggle-cursor-follows-scrollbar -\end_layout -\begin_layout Description -Origin ARRae, 2 Dec 1997 +cut \end_layout -\begin_layout Subsection* -LFUN_CUT -\end_layout \begin_layout Description Action Cuts to the clipboard. \end_layout + \begin_layout Description Syntax cut \end_layout \begin_layout Subsection* -LFUN_DATE_INSERT +date-insert \end_layout + \begin_layout Description Action Inserts the current date. \end_layout + \begin_layout Description Syntax date-insert [] \end_layout + \begin_layout Description Params : Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function. \end_layout + \begin_layout Description Origin jdblair, 31 Jan 2000 \end_layout \begin_layout Subsection* -LFUN_DEBUG_LEVEL_SET -\end_layout -\begin_layout Description -Action Set debug output level. -\end_layout -\begin_layout Description -Syntax debug-level-set -\end_layout -\begin_layout Description -Params : comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers. -\end_layout -\begin_layout Description -Origin sanda, 28 Dec 2009 +depth-decrement \end_layout -\begin_layout Subsection* -LFUN_DEPTH_DECREMENT -\end_layout \begin_layout Description Action Decrease the nesting depth of the (selected) paragraph(s) inside lists. \end_layout + \begin_layout Description Syntax depth-decrement \end_layout \begin_layout Subsection* -LFUN_DEPTH_INCREMENT +depth-increment \end_layout + \begin_layout Description Action Increase the nesting depth of the (selected) paragraph(s) inside lists. \end_layout + \begin_layout Description Syntax depth-increment \end_layout \begin_layout Subsection* -LFUN_DIALOG_DISCONNECT_INSET +dialog-disconnect-inset \end_layout + \begin_layout Description Action Closes opened connection to opened inset. \end_layout + \begin_layout Description Notion Connection is used for apply functions. \end_layout + \begin_layout Description Syntax dialog-disconnect-inset \end_layout + \begin_layout Description Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_DIALOG_HIDE +dialog-hide \end_layout + \begin_layout Description Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW . \end_layout + \begin_layout Description Syntax dialog-hide \end_layout + \begin_layout Description Params See LFUN_DIALOG_SHOW . \end_layout + \begin_layout Description Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_DIALOG_SHOW +dialog-show \end_layout + \begin_layout Description Action Shows hidden dialog or creates new one for a given function/inset settings etc. \end_layout + \begin_layout Description Syntax dialog-show [] \end_layout + \begin_layout Description Params : aboutlyx|bibitem|bibtex|box|branch|changes|character|citation| \begin_inset Newline newline @@ -1863,57 +1782,71 @@ thesaurus|texinfo|toc|view-source|vspace|wrap| : data, usually settings for the given dialog. Use debug mode for the details. \end_layout + \begin_layout Description Origin leeming, 17 Jun 2003 \end_layout \begin_layout Subsection* -LFUN_DIALOG_SHOW_NEW_INSET +dialog-show-new-inset \end_layout + \begin_layout Description Action Shows hidden dialog or create new one for a given inset settings etc. \end_layout + \begin_layout Description Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset. \end_layout + \begin_layout Description Syntax dialog-show-new-inset [] \end_layout + \begin_layout Description Params See LFUN_DIALOG_SHOW . \end_layout + \begin_layout Description Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_DIALOG_TOGGLE +dialog-toggle \end_layout + \begin_layout Description Action Toggles dialog between showed/hidden state. \end_layout + \begin_layout Description Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE . \end_layout + \begin_layout Description Syntax dialog-toggle [] \end_layout + \begin_layout Description Params See LFUN_DIALOG_SHOW . \end_layout + \begin_layout Description Origin JSpitzm, 30 Apr 2007 \end_layout \begin_layout Subsection* -LFUN_DIALOG_UPDATE +dialog-update \end_layout + \begin_layout Description Action Updates the dialog values from the inset/paragraph/document. \end_layout + \begin_layout Description Syntax dialog-update \end_layout + \begin_layout Description Params : paragraph|prefs| \begin_inset Newline newline @@ -1921,189 +1854,131 @@ Params : paragraph|prefs| : inset name \end_layout + \begin_layout Description Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_DOWN +down \end_layout + \begin_layout Description Action Moves the cursor one line in downward direction. \end_layout + \begin_layout Description Syntax down \end_layout \begin_layout Subsection* -LFUN_DOWN_SELECT +down-select \end_layout + \begin_layout Description Action Moves the cursor one line in downward direction adding the current position to the selection. \end_layout + \begin_layout Description Syntax down-select \end_layout \begin_layout Subsection* -LFUN_DROP_LAYOUTS_CHOICE +ert-insert \end_layout + \begin_layout Description -Action Displays list of layout choices. +Action Inserts an ERT inset. \end_layout + \begin_layout Description -Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. +Syntax ert-insert \end_layout + \begin_layout Description -Syntax drop-layouts-choice +Origin Jug, 18 Feb 2000 \end_layout \begin_layout Subsection* -LFUN_ENVIRONMENT_SPLIT +escape \end_layout + \begin_layout Description -Action Splits the current environment with a Separator. +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 environment-split [outer] -\end_layout -\begin_layout Description -Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. -\end_layout -\begin_layout Description -Origin spitz, 23 Dec 2012 -\end_layout - -\begin_layout Subsection* -LFUN_ERT_INSERT -\end_layout -\begin_layout Description -Action Inserts an ERT inset. -\end_layout -\begin_layout Description -Syntax ert-insert -\end_layout -\begin_layout Description -Origin Jug, 18 Feb 2000 -\end_layout - -\begin_layout Subsection* -LFUN_ESCAPE -\end_layout -\begin_layout Description -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 escape +Syntax escape \end_layout + \begin_layout Description Origin Lgb, 17 May 2001 \end_layout \begin_layout Subsection* -LFUN_FILE_INSERT +file-insert \end_layout + \begin_layout Description Action Inserts another LyX file. \end_layout + \begin_layout Description Syntax file-insert [] \end_layout + \begin_layout Description Params : Filename to be inserted. \end_layout \begin_layout Subsection* -LFUN_FILE_INSERT_PLAINTEXT +file-insert-plaintext \end_layout + \begin_layout Description Action Inserts plain text file. \end_layout + \begin_layout Description Syntax file-insert-plaintext [] \end_layout + \begin_layout Description Params : Filename to be inserted. \end_layout + \begin_layout Description Origin CFO-G, 19 Nov 1997 \end_layout \begin_layout Subsection* -LFUN_FILE_INSERT_PLAINTEXT_PARA -\end_layout -\begin_layout Description -Action Inserts plain text file as paragraph (i.e. join lines). -\end_layout -\begin_layout Description -Syntax file-insert-plaintext-para [] -\end_layout -\begin_layout Description -Params : Filename to be inserted. -\end_layout -\begin_layout Description -Origin Levon, 14 Feb 2001 +file-insert-plaintext-para \end_layout -\begin_layout Subsection* -LFUN_FILE_OPEN -\end_layout \begin_layout Description -Action Open LyX document. -\end_layout -\begin_layout Description -Syntax file-open [] -\end_layout -\begin_layout Description -Params : Filename to be opened. +Action Inserts plain text file as paragraph (i.e. join lines). \end_layout -\begin_layout Subsection* -LFUN_FINISHED_BACKWARD -\end_layout -\begin_layout Description -Action Moves the cursor out of the current slice, going backwards. -\end_layout \begin_layout Description -Notion See also LFUN_FINISHED_FORWARD. +Syntax file-insert-plaintext-para [] \end_layout -\begin_layout Subsection* -LFUN_FINISHED_FORWARD -\end_layout -\begin_layout Description -Action Moves the cursor out of the current slice, going forward. -\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. +Params : Filename to be inserted. \end_layout -\begin_layout Subsection* -LFUN_FINISHED_LEFT -\end_layout \begin_layout Description -Action Moves the cursor out of the current slice, going left. -\end_layout -\begin_layout Description -Notion See also LFUN_FINISHED_FORWARD. +Origin Levon, 14 Feb 2001 \end_layout \begin_layout Subsection* -LFUN_FINISHED_RIGHT -\end_layout -\begin_layout Description -Action Moves the cursor out of the current slice, going right. -\end_layout -\begin_layout Description -Notion See also LFUN_FINISHED_FORWARD +flex-insert \end_layout -\begin_layout Subsection* -LFUN_FLEX_INSERT -\end_layout \begin_layout Description Action Inserts CharStyle, Custom inset or XML short element. \end_layout + \begin_layout Description Notion Look into the Customization manual for more information about these elements. \begin_inset Newline newline @@ -2115,509 +1990,357 @@ To make this command enabled the layout file for the document class you're using For dissolving the element see LFUN_INSET_DISSOLVE. \end_layout + \begin_layout Description Syntax flex-insert Name \end_layout + \begin_layout Description Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. \end_layout + \begin_layout Description Sample flex-insert Code \end_layout \begin_layout Subsection* -LFUN_FLOAT_INSERT +float-insert \end_layout + \begin_layout Description Action Inserts a float inset. \end_layout + \begin_layout Description Syntax float-insert \end_layout + \begin_layout Description Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout + \begin_layout Description Origin Lgb, 27 Jun 2000 \end_layout \begin_layout Subsection* -LFUN_FLOAT_LIST_INSERT +float-list-insert \end_layout + \begin_layout Description Action Inserts the list of floats in the document. \end_layout + \begin_layout Description Syntax float-list-insert \end_layout + \begin_layout Description Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout + \begin_layout Description Origin Lgb, 3 May 2001 \end_layout \begin_layout Subsection* -LFUN_FLOAT_WIDE_INSERT +float-wide-insert \end_layout + \begin_layout Description Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns. \end_layout + \begin_layout Description Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. \end_layout + \begin_layout Description Syntax float-wide-insert \end_layout + \begin_layout Description Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout + \begin_layout Description Origin Lgb, 31 Oct 2001 \end_layout \begin_layout Subsection* -LFUN_FONT_BOLD +footnote-insert \end_layout + \begin_layout Description -Action Toggles the bold font (selection-wise) using mathbf in math. +Action Inserts a footnote inset. \end_layout + \begin_layout Description -Syntax font-bold +Syntax footnote-insert +\end_layout + +\begin_layout Description +Origin Jug, 7 Mar 2000 \end_layout \begin_layout Subsection* -LFUN_FONT_BOLDSYMBOL +graphics-reload \end_layout + \begin_layout Description -Action Toggles the bold font (selection-wise) using boldsymbol in math. +Action Reloads the image if necessary. \end_layout + \begin_layout Description -Syntax font-boldsymbol +Syntax graphics-reload +\end_layout + +\begin_layout Description +Origin vfr, 10 Aug 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_DEFAULT +href-insert \end_layout + \begin_layout Description -Action Reverts the settings of the font to the default values (selection-wise). +Action Inserts hyperlinks into the document (clickable in pdf output). \end_layout + \begin_layout Description -Syntax font-default +Notion Hyperlink target can be set via selection + hyperlink-insert function. \end_layout -\begin_layout Subsection* -LFUN_FONT_EMPH -\end_layout \begin_layout Description -Action Toggles the emphasis font style (selection-wise). +Syntax href-insert [] \end_layout + \begin_layout Description -Syntax font-emph +Origin CFO-G, 21 Nov 1997 \end_layout \begin_layout Subsection* -LFUN_FONT_FRAK +in-ipa +\end_layout + +\begin_layout Description +Action Only active in IPA inset. \end_layout + \begin_layout Description -Action Toggles Fraktur family font (math-mode, selection-wise). +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 font-frak +Syntax in-ipa \end_layout + \begin_layout Description -Origin vermeer, 10 Jan 2002 +Origin spitz, 20 May 2012 \end_layout \begin_layout Subsection* -LFUN_FONT_ITAL +index-insert \end_layout + \begin_layout Description -Action Toggles Italics font shape (math-mode, selection-wise). +Action Inserts Index entry. \end_layout + \begin_layout Description -Syntax font-ital +Notion It automatically takes the word on the cursor position. \end_layout + \begin_layout Description -Origin vermeer, 10 Jan 2002 +Syntax index-insert [] \end_layout -\begin_layout Subsection* -LFUN_FONT_NOUN -\end_layout \begin_layout Description -Action Toggles Noun text style font (selection-wise). +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout + \begin_layout Description -Syntax font-noun +Origin leeming, 3 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_FONT_ROMAN +index-print \end_layout + \begin_layout Description -Action Toggles Roman family font (selection-wise). +Action Inserts list of Index entries on a new page. \end_layout + \begin_layout Description -Syntax font-roman +Syntax index-print [] \end_layout -\begin_layout Subsection* -LFUN_FONT_SANS -\end_layout \begin_layout Description -Action Toggles Sans Serif family font (selection-wise). +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout + \begin_layout Description -Syntax font-sans +Origin Lgb, 27 Feb 1997 \end_layout \begin_layout Subsection* -LFUN_FONT_SIZE -\end_layout -\begin_layout Description -Action Sets font size according to lyx format string. +info-insert \end_layout + \begin_layout Description -Syntax font-size +Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. \end_layout + \begin_layout Description -Params : tiny|scriptsize|footnotesize|small|normal|large|larger| +Notion Apart from lfun arguments you can use the following method: \begin_inset Newline newline \end_inset -largest|huge|giant|increase|decrease|default -\end_layout +1. input the type and argument of this inset, e.g. "menu paste", in the work area. +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_FONT_STATE -\end_layout -\begin_layout Description -Action Returns the info about the current font. +2. select the text and run info-insert lfun. \end_layout + \begin_layout Description -Syntax font-state +Syntax info-insert \end_layout -\begin_layout Subsection* -LFUN_FONT_STRIKEOUT -\end_layout \begin_layout Description -Action Toggles strikeout (strike-through) in the font (selection-wise). +Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer +\begin_inset Newline newline +\end_inset + +: argument for a given type. Look into InsetInfo.h for detailed description. +\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 + + icon: icon of lfun used in toolbar or direct icon name +\begin_inset Newline newline +\end_inset + + buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" \end_layout + \begin_layout Description -Syntax font-strikeout +Sample command-sequence info-insert buffer path; info-insert buffer name \end_layout + \begin_layout Description -Origin sanda, 3 May 2009 +Origin bpeng, 7 Oct 2007 \end_layout \begin_layout Subsection* -LFUN_FONT_TYPEWRITER +inset-apply \end_layout + \begin_layout Description -Action Toggles the typewriter family font (selection-wise). +Action Apply data for an inset. \end_layout + \begin_layout Description -Syntax font-typewriter +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 Subsection* -LFUN_FONT_UNDERLINE -\end_layout \begin_layout Description -Action Toggles underline in the font (selection-wise). +Syntax inset-apply \end_layout + \begin_layout Description -Syntax font-underline +Params See LFUN_INSET_INSERT . \end_layout \begin_layout Subsection* -LFUN_FONT_UULINE +inset-begin \end_layout + \begin_layout Description -Action Toggles double underline in the font (selection-wise). +Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise \end_layout + \begin_layout Description -Syntax font-underunderline -\end_layout -\begin_layout Description -Origin sanda, 5 May 2009 -\end_layout - -\begin_layout Subsection* -LFUN_FONT_UWAVE -\end_layout -\begin_layout Description -Action Toggles wavy underline in the font (selection-wise). -\end_layout -\begin_layout Description -Syntax font-underwave -\end_layout -\begin_layout Description -Origin sanda, 5 May 2009 -\end_layout - -\begin_layout Subsection* -LFUN_FOOTNOTE_INSERT -\end_layout -\begin_layout Description -Action Inserts a footnote inset. -\end_layout -\begin_layout Description -Syntax footnote-insert -\end_layout -\begin_layout Description -Origin Jug, 7 Mar 2000 -\end_layout - -\begin_layout Subsection* -LFUN_FORWARD_SEARCH -\end_layout -\begin_layout Description -Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window. -\end_layout -\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 -Syntax forward-search -\end_layout -\begin_layout Description -Origin sanda, 14 Apr 2010 -\end_layout - -\begin_layout Subsection* -LFUN_GRAPHICS_RELOAD -\end_layout -\begin_layout Description -Action Reloads the image if necessary. -\end_layout -\begin_layout Description -Syntax graphics-reload -\end_layout -\begin_layout Description -Origin vfr, 10 Aug 2009 -\end_layout - -\begin_layout Subsection* -LFUN_HELP_OPEN -\end_layout -\begin_layout Description -Action Open the given help file according to the language setting. -\end_layout -\begin_layout Description -Syntax help-open [.lyx] -\end_layout -\begin_layout Description -Params : any document from (/usr/share/)doc directory. -\end_layout -\begin_layout Description -Origin Jug, 27 Jun 1999 -\end_layout - -\begin_layout Subsection* -LFUN_HYPERLINK_INSERT -\end_layout -\begin_layout Description -Action Inserts hyperlinks into the document (clickable in pdf output). -\end_layout -\begin_layout Description -Notion Hyperlink target can be set via selection + hyperlink-insert function. -\end_layout -\begin_layout Description -Syntax href-insert [] -\end_layout -\begin_layout Description -Origin CFO-G, 21 Nov 1997 -\end_layout - -\begin_layout Subsection* -LFUN_INDEX_INSERT -\end_layout -\begin_layout Description -Action Inserts Index entry. -\end_layout -\begin_layout Description -Notion It automatically takes the word on the cursor position. -\end_layout -\begin_layout Description -Syntax index-insert [] -\end_layout -\begin_layout Description -Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. -\end_layout -\begin_layout Description -Origin leeming, 3 Aug 2000 +Syntax inset-begin \end_layout -\begin_layout Subsection* -LFUN_INDEX_PRINT -\end_layout -\begin_layout Description -Action Inserts list of Index entries on a new page. -\end_layout -\begin_layout Description -Syntax index-print [] -\end_layout -\begin_layout Description -Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. -\end_layout \begin_layout Description -Origin Lgb, 27 Feb 1997 +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_INFO_INSERT -\end_layout -\begin_layout Description -Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. -\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. -\end_layout -\begin_layout Description -Syntax info-insert +inset-begin-select \end_layout -\begin_layout Description -Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer -\begin_inset Newline newline -\end_inset - -: argument for a given type. Look into InsetInfo.h for detailed description. -\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 - - icon: icon of lfun used in toolbar -\begin_inset Newline newline -\end_inset - buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" -\end_layout \begin_layout Description -Sample command-sequence info-insert buffer path; info-insert buffer name -\end_layout -\begin_layout Description -Origin bpeng, 7 Oct 2007 +Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). \end_layout -\begin_layout Subsection* -LFUN_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 -\end_layout \begin_layout Description -Params See LFUN_INSET_INSERT . +Syntax inset-begin-select \end_layout -\begin_layout Subsection* -LFUN_INSET_BEGIN -\end_layout -\begin_layout Description -Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise -\end_layout -\begin_layout Description -Syntax inset-begin -\end_layout \begin_layout Description Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_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, or at the beginning of the enclosing inset otherwise (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 +inset-copy-as \end_layout -\begin_layout Subsection* -LFUN_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* -LFUN_INSET_DIALOG_UPDATE -\end_layout -\begin_layout Description -Action Updates the values inside the dialog from the inset. -\end_layout -\begin_layout Description -Notion This is an internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE -\end_layout -\begin_layout Description -Params -\end_layout -\begin_layout Description -Origin leeming, 25 Feb 2003 +inset-dissolve \end_layout -\begin_layout Subsection* -LFUN_INSET_DISSOLVE -\end_layout \begin_layout Description Action Dissolve the current inset into text. \end_layout + \begin_layout Description Syntax inset-dissolve [] \end_layout + \begin_layout Description Params : 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 @@ -2625,19 +2348,23 @@ Params : this can be used to make sure the right kind of inset is dissolv For values see lyx::InsetLayout::lyxtype_ . \end_layout + \begin_layout Description Origin JSpitz, 7 Aug 2006 \end_layout \begin_layout Subsection* -LFUN_INSET_EDIT +inset-edit \end_layout + \begin_layout Description Action Edit the inset at cursor with an external application, if one is attributed. \end_layout + \begin_layout Description Syntax inset-edit [] \end_layout + \begin_layout Description Params : Parameters for the inset. \begin_inset Newline newline @@ -2645,45 +2372,55 @@ Params : Parameters for the inset. Currently only the filename will be considered. \end_layout + \begin_layout Description Origin JSpitzm, 27 Apr 2006 \end_layout \begin_layout Subsection* -LFUN_INSET_END +inset-end \end_layout + \begin_layout Description Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise \end_layout + \begin_layout Description Syntax inset-end \end_layout + \begin_layout Description Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_INSET_END_SELECT +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, or at the end of the enclosing inset otherwise (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* -LFUN_INSET_FORALL +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 \begin_inset Newline newline @@ -2691,12 +2428,13 @@ Syntax inset-forall : Type of Inset. If 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 + inset-forall Index char-delete-forward force \begin_inset Newline newline \end_inset @@ -2722,19 +2460,23 @@ Try to put LyX in an infinite loop if there is at least a Note: inset-forall Note char-backward \end_layout + \begin_layout Description Origin lasgouttes, 27 Nov 2009 \end_layout \begin_layout Subsection* -LFUN_INSET_INSERT +inset-insert \end_layout + \begin_layout Description Action Insert new inset (type given by the parameters). \end_layout + \begin_layout Description Syntax inset-insert \end_layout + \begin_layout Description Params : : : depends on the given inset. Use "lyx -dbg action" to explore. \end_layout + \begin_layout Description Sample inset-insert ref LatexCommand reference "