From e621229ee392b957d5862f216e02be588c43a3cf Mon Sep 17 00:00:00 2001 From: Juergen Spitzmueller Date: Mon, 10 Feb 2014 09:31:46 +0100 Subject: [PATCH] update FUNs.lyx --- lib/doc/LFUNs.lyx | 6473 +++++++++++++++++---------------------------- 1 file changed, 2438 insertions(+), 4035 deletions(-) diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index ade3fffbd0..f271dd473d 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -1,4 +1,4 @@ -#LyX 2.1 created this file. For more info see http://www.lyx.org/ +# gen_lfuns.py generated this file. For more info see http://www.lyx.org/ \lyxformat 474 \begin_document \begin_header @@ -65,7 +65,7 @@ \leftmargin 2.5cm \topmargin 2cm \rightmargin 3cm -\bottommargin 1cm +\bottommargin 2.5cm \secnumdepth 3 \tocdepth 3 \paragraph_separation indent @@ -83,8 +83,16 @@ \begin_body -\begin_layout Section* -LFUNs documentation automatically generated 2013-10-05 +\begin_layout Title +LyX Functions (LFUNs) +\end_layout + +\begin_layout Author +The LyX Team +\end_layout + +\begin_layout Date +2014-02-10 \end_layout \begin_layout Standard @@ -106,15 +114,12 @@ thispagestyle{empty} \end_layout - \begin_layout Subsection* LFUN_ACCENT_ACUTE \end_layout - \begin_layout Description Action Adds an acute accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-acute \end_layout @@ -122,11 +127,9 @@ Syntax accent-acute \begin_layout Subsection* LFUN_ACCENT_BREVE \end_layout - \begin_layout Description Action Adds a breve accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-breve \end_layout @@ -134,11 +137,9 @@ Syntax accent-breve \begin_layout Subsection* LFUN_ACCENT_CARON \end_layout - \begin_layout Description Action Adds a caron to the next character typed. \end_layout - \begin_layout Description Syntax accent-caron \end_layout @@ -146,11 +147,9 @@ Syntax accent-caron \begin_layout Subsection* LFUN_ACCENT_CEDILLA \end_layout - \begin_layout Description Action Adds a cedilla to the next character typed. \end_layout - \begin_layout Description Syntax accent-cedilla \end_layout @@ -158,11 +157,9 @@ Syntax accent-cedilla \begin_layout Subsection* LFUN_ACCENT_CIRCLE \end_layout - \begin_layout Description Action Adds a circle accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-circle \end_layout @@ -170,11 +167,9 @@ Syntax accent-circle \begin_layout Subsection* LFUN_ACCENT_CIRCUMFLEX \end_layout - \begin_layout Description Action Adds a circumflex to the next character typed. \end_layout - \begin_layout Description Syntax accent-circumflex \end_layout @@ -182,11 +177,9 @@ Syntax accent-circumflex \begin_layout Subsection* LFUN_ACCENT_DOT \end_layout - \begin_layout Description Action Adds a dot accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-dot \end_layout @@ -194,11 +187,9 @@ Syntax accent-dot \begin_layout Subsection* LFUN_ACCENT_GRAVE \end_layout - \begin_layout Description Action Adds a grave accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-grave \end_layout @@ -206,11 +197,9 @@ Syntax accent-grave \begin_layout Subsection* LFUN_ACCENT_HUNGARIAN_UMLAUT \end_layout - \begin_layout Description Action Adds a Hungarian umlaut to the next character typed. \end_layout - \begin_layout Description Syntax accent-grave \end_layout @@ -218,11 +207,9 @@ Syntax accent-grave \begin_layout Subsection* LFUN_ACCENT_MACRON \end_layout - \begin_layout Description Action Adds a macron to the next character typed. \end_layout - \begin_layout Description Syntax accent-macron \end_layout @@ -230,11 +217,9 @@ Syntax accent-macron \begin_layout Subsection* LFUN_ACCENT_OGONEK \end_layout - \begin_layout Description Action Adds an ogonek accent to the next character typed. \end_layout - \begin_layout Description Syntax accent-ogonek \end_layout @@ -242,15 +227,12 @@ Syntax accent-ogonek \begin_layout Subsection* LFUN_ACCENT_TIE \end_layout - \begin_layout Description Action Adds a tie over the next two character typed. \end_layout - \begin_layout Description Notion The following char will finish the tie. \end_layout - \begin_layout Description Syntax accent-tie \end_layout @@ -258,11 +240,9 @@ Syntax accent-tie \begin_layout Subsection* LFUN_ACCENT_TILDE \end_layout - \begin_layout Description Action Adds a tilde over the next character typed. \end_layout - \begin_layout Description Syntax accent-tilde \end_layout @@ -270,11 +250,9 @@ Syntax accent-tilde \begin_layout Subsection* LFUN_ACCENT_UMLAUT \end_layout - \begin_layout Description Action Adds an umlaut over the next character typed. \end_layout - \begin_layout Description Syntax accent-umlaut \end_layout @@ -282,11 +260,9 @@ Syntax accent-umlaut \begin_layout Subsection* LFUN_ACCENT_UNDERBAR \end_layout - \begin_layout Description Action Adds a bar under the next character typed. \end_layout - \begin_layout Description Syntax accent-underbar \end_layout @@ -294,2241 +270,1961 @@ Syntax accent-underbar \begin_layout Subsection* LFUN_ACCENT_UNDERDOT \end_layout - \begin_layout Description Action Adds a dot under the next character typed. \end_layout - \begin_layout Description Syntax accent-underdot \end_layout \begin_layout Subsection* -LFUN_CAPTION_INSERT +LFUN_ALL_CHANGES_ACCEPT \end_layout - \begin_layout Description -Action Inserts a caption inset. +Action Accepts all tracked changes in the document. \end_layout - \begin_layout Description -Syntax caption-insert +Syntax all-changes-accept \end_layout - \begin_layout Description -Origin Lgb, 18 Jul 2000 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_DATE_INSERT +LFUN_ALL_CHANGES_REJECT \end_layout - \begin_layout Description -Action Inserts the current date. +Action Rejects all tracked changes in the document. \end_layout - \begin_layout Description -Syntax date-insert [] +Notion Reject does not work recursively; the user may have to repeat the operation. \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. +Syntax all-changes-reject \end_layout - \begin_layout Description -Origin jdblair, 31 Jan 2000 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_FOOTNOTE_INSERT +LFUN_APPENDIX \end_layout - \begin_layout Description -Action Inserts a footnote inset. +Action Start (or remove) Appendix on the given cursor position. \end_layout - \begin_layout Description -Syntax footnote-insert +Syntax appendix \end_layout - \begin_layout Description -Origin Jug, 7 Mar 2000 +Origin ettrich, 5 May 1998 \end_layout \begin_layout Subsection* -LFUN_ERT_INSERT +LFUN_ARGUMENT_INSERT \end_layout - \begin_layout Description -Action Inserts an ERT inset. +Action Inserts an argument (short title) inset. \end_layout - \begin_layout Description -Syntax ert-insert +Syntax argument-insert \end_layout - \begin_layout Description -Origin Jug, 18 Feb 2000 +Params : see layout declarations +\end_layout +\begin_layout Description +Origin vermeer, 12 Aug 2002 \end_layout \begin_layout Subsection* -LFUN_FLOAT_INSERT +LFUN_BIBTEX_DATABASE_ADD \end_layout - \begin_layout Description -Action Inserts a float inset. +Action Adds database, which will be used for bibtex citations. \end_layout - \begin_layout Description -Syntax float-insert +Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout - \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Syntax bibtex-database-add \end_layout - \begin_layout Description -Origin Lgb, 27 Jun 2000 +Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_FLOAT_WIDE_INSERT +LFUN_BIBTEX_DATABASE_DEL \end_layout - \begin_layout Description -Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns. +Action Adds database, which will be used for bibtex citations. \end_layout - \begin_layout Description -Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX. +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 float-wide-insert +Syntax bibtex-database-del \end_layout - \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Origin Ale, 30 May 1997 \end_layout +\begin_layout Subsection* +LFUN_BOOKMARK_CLEAR +\end_layout \begin_layout Description -Origin Lgb, 31 Oct 2001 +Action Clears the list of saved bookmarks. +\end_layout +\begin_layout Description +Syntax bookmark-clear +\end_layout +\begin_layout Description +Origin bpeng, 31 October 2006 \end_layout \begin_layout Subsection* -LFUN_FLOAT_LIST_INSERT +LFUN_BOOKMARK_GOTO \end_layout - \begin_layout Description -Action Inserts the list of floats in the 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 +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 -Syntax float-list-insert +Syntax bookmark-goto \end_layout - \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Params : the number of the bookmark to restore. \end_layout - \begin_layout Description -Origin Lgb, 3 May 2001 +Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_WRAP_INSERT +LFUN_BOOKMARK_SAVE \end_layout - \begin_layout Description -Action Inserts floats wrapped by the text around. +Action Save a bookmark. \end_layout - \begin_layout Description -Syntax wrap-insert +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 Description -Params : table|figure +Syntax bookmark-save \end_layout - \begin_layout Description -Origin Dekel, 7 Apr 2002 +Params : the number of the bookmark to save. +\end_layout +\begin_layout Description +Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_ARGUMENT_INSERT +LFUN_BOX_INSERT \end_layout - \begin_layout Description -Action Inserts an argument (short title) inset. +Action Inserts Box inset. \end_layout - \begin_layout Description -Syntax argument-insert +Syntax box-insert [] \end_layout - \begin_layout Description -Params : see layout declarations -\end_layout +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, 12 Aug 2002 +Origin vermeer, 7 Oct 2003 \end_layout \begin_layout Subsection* -LFUN_NEWPAGE_INSERT +LFUN_BRANCHES_RENAME \end_layout - \begin_layout Description -Action Inserts a new page. +Action Rename all branches of a given name in a document. \end_layout - \begin_layout Description -Syntax newpage-insert +Syntax branches-rename \end_layout - \begin_layout Description -Params : default: newpage +Params : Current name of the branch to be renamed : New name of the branch \end_layout - \begin_layout Description -Origin uwestoehr, 24 Nov 2007 +Origin spitz, 9 Jul 2009 \end_layout \begin_layout Subsection* -LFUN_MARGINALNOTE_INSERT +LFUN_BRANCH_ACTIVATE \end_layout - \begin_layout Description -Action Inserts a marginal note. +Action Activate the branch. \end_layout - \begin_layout Description -Syntax marginalnote-insert +Syntax branch-activate \end_layout - \begin_layout Description -Origin Lgb, 26 Jun 2000 +Params : The branch to activate \end_layout +\begin_layout Description +Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_UNICODE_INSERT +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 -Action Inserts a single unicode character. +Origin rgh, 27 May 2008 \end_layout +\begin_layout Subsection* +LFUN_BRANCH_ADD +\end_layout \begin_layout Description -Syntax unicode-insert +Action Add a branch to the buffer's BranchList. \end_layout - \begin_layout Description -Params : The character to insert, given as its code point, in hexadecimal. +Syntax branch-add \end_layout - \begin_layout Description -Sample unicode-insert 0x0100 +Params : Name of the branch to add \end_layout - \begin_layout Description -Origin Lgb, 22 Oct 2006 +Origin spitz, 7 Jul 2009 \end_layout \begin_layout Subsection* -LFUN_LISTING_INSERT +LFUN_BRANCH_ADD_INSERT \end_layout - \begin_layout Description -Action Inserts a new listings inset. +Action Create new branch and directly put the branch inset into the document. \end_layout - \begin_layout Description -Syntax listing-insert +Syntax branch-add-insert [] \end_layout - \begin_layout Description -Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007 +Params : Branch name. If it is not specified, you will be asked. +\end_layout +\begin_layout Description +Origin sanda, 10 Jul 2009 \end_layout \begin_layout Subsection* -LFUN_PREVIEW_INSERT +LFUN_BRANCH_DEACTIVATE \end_layout - \begin_layout Description -Action Inserts a new preview inset. +Action De-activate the branch. \end_layout - \begin_layout Description -Syntax preview-insert +Syntax branch-deactivate \end_layout - \begin_layout Description -Origin vfr, 28 Mar 2010 +Params : The branch to deactivate +\end_layout +\begin_layout Description +Origin rgh, 27 May 2008 \end_layout \begin_layout Subsection* -LFUN_TAB_INSERT +LFUN_BRANCH_INSERT \end_layout - \begin_layout Description -Action Insert a tab into a listings inset. +Action Inserts branch inset. \end_layout - \begin_layout Description -Notion It also works on a selection. -\end_layout - -\begin_layout Description -Syntax tab-insert +Syntax branch-insert \end_layout - \begin_layout Description -Origin vfr, Sep 30 2008 +Origin vermeer, 17 Aug 2003 \end_layout \begin_layout Subsection* -LFUN_TAB_DELETE +LFUN_BRANCH_MASTER_ACTIVATE \end_layout - \begin_layout Description -Action Delete a tab or up to an equivalent amount of spaces from a listings - inset. +Action Activate the branch in the master buffer. \end_layout - \begin_layout Description -Notion It also works on a selection - it removes a tab or spaces from the - beginning of each line spanned by the selection. - This is useful if you want to indent/unindent multiple lines in one action. +Syntax branch-master-activate \end_layout - \begin_layout Description -Syntax tab-delete +Params : The branch to activate \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 vfr, Sep 30 2008 +Origin spitz, 30 Sep 2012 \end_layout \begin_layout Subsection* -LFUN_QUOTE_INSERT +LFUN_BRANCH_MASTER_DEACTIVATE \end_layout - \begin_layout Description -Action Inserts quotes according to the type and quote-language preference. +Action De-activate the branch in the master buffer. \end_layout - \begin_layout Description -Notion Currently English, Swedish, German, Polish, French, Danish quotes - are distinguished. +Syntax branch-master-deactivate \end_layout - \begin_layout Description -Syntax quote-insert [] +Params : The branch to deactivate \end_layout - \begin_layout Description -Params : 'single' for single quotes, otherwise double quotes will - be used. +Origin spitz, 30 Sep 2012 \end_layout \begin_layout Subsection* -LFUN_INFO_INSERT +LFUN_BUFFER_AUTO_SAVE \end_layout - \begin_layout Description -Action Displays shortcuts, lyxrc, package and textclass availability and - menu information in a non-editable boxed InsetText. +Action Saves the current buffer to a temporary file. \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. +Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer. \end_layout - \begin_layout Description -Syntax info-insert +Syntax buffer-auto-save \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-a -uthor"|"vcs-date"|"vcs-time" +\begin_layout Subsection* +LFUN_BUFFER_BEGIN \end_layout - \begin_layout Description -Sample command-sequence info-insert buffer path; info-insert buffer name +Action Move the cursor to the beginning of the document. \end_layout - \begin_layout Description -Origin bpeng, 7 Oct 2007 +Syntax buffer-begin \end_layout \begin_layout Subsection* -LFUN_BRANCH_INSERT -\end_layout - -\begin_layout Description -Action Inserts branch inset. +LFUN_BUFFER_BEGIN_SELECT \end_layout - \begin_layout Description -Syntax branch-insert +Action Move the cursor to the beginning of the document adding the traversed text to the selection. \end_layout - \begin_layout Description -Origin vermeer, 17 Aug 2003 +Syntax buffer-begin-select \end_layout \begin_layout Subsection* -LFUN_BOX_INSERT +LFUN_BUFFER_CHILD_OPEN \end_layout - \begin_layout Description -Action Inserts Box inset. +Action Loads the given child document. \end_layout - \begin_layout Description -Syntax box-insert [] +Notion The current document is treated as a parent. \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. +Syntax buffer-child-open \end_layout - \begin_layout Description -Origin vermeer, 7 Oct 2003 -\end_layout - -\begin_layout Subsection* -LFUN_FLEX_INSERT +Params : Filename of the child. The directory of the parent is assumed by default. \end_layout - \begin_layout Description -Action Inserts CharStyle, Custom inset or XML short element. +Origin Ale, 28 May 1997 \end_layout -\begin_layout Description -Notion Look into the Customization manual for more information about these - elements. -\begin_inset Newline newline -\end_inset - -To make this command enabled the layout file for the document class you're - using has to load the character styles. - There are a few contained in the Logical Markup module. - You can also of course create some yourself. -\begin_inset Newline newline -\end_inset - -For dissolving the element see LFUN_INSET_DISSOLVE. +\begin_layout Subsection* +LFUN_BUFFER_CHKTEX \end_layout - \begin_layout Description -Syntax flex-insert Name +Action Runs chktex for the current document. \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. +Syntax buffer-chktex \end_layout - \begin_layout Description -Sample flex-insert Code +Origin Asger, 30 Oct 1997 \end_layout \begin_layout Subsection* -LFUN_SELF_INSERT +LFUN_BUFFER_CLOSE \end_layout - \begin_layout Description -Action Inserts the given string (accordingly to the correct keymap). +Action Closes the current buffer. \end_layout - \begin_layout Description -Notion Automatically replace the currently selected text. - Depends on lyxrc settings "auto_region_delete". +Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified. \end_layout - \begin_layout Description -Syntax self-insert +Syntax buffer-close \end_layout \begin_layout Subsection* -LFUN_SPACE_INSERT -\end_layout - -\begin_layout Description -Action Inserts one of horizontal space insets. +LFUN_BUFFER_CLOSE_ALL \end_layout - \begin_layout Description -Syntax space-insert [] +Action Closes all buffers. \end_layout - \begin_layout Description -Params : normal, protected, visible, thin, quad, qquad, enspace, enskip, - negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, - hspace, hspace* -\begin_inset Newline newline -\end_inset - -Only in math mode: med and thick. -\begin_inset Newline newline -\end_inset - -: length for custom spaces (hspace, hspace* for protected) +Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified. \end_layout - \begin_layout Description -Origin JSpitzm, 20 May 2003, Mar 17 2008 +Syntax buffer-close-all \end_layout \begin_layout Subsection* -LFUN_HYPERLINK_INSERT +LFUN_BUFFER_END \end_layout - \begin_layout Description -Action Inserts hyperlinks into the document (clickable in pdf output). +Action Move the cursor to the end of the document. \end_layout - \begin_layout Description -Notion Hyperlink target can be set via selection + hyperlink-insert function. +Syntax buffer-end \end_layout +\begin_layout Subsection* +LFUN_BUFFER_END_SELECT +\end_layout \begin_layout Description -Syntax href-insert [] +Action Move the cursor to the end of the document adding the traversed text to the selection. \end_layout - \begin_layout Description -Origin CFO-G, 21 Nov 1997 +Syntax buffer-end-select \end_layout \begin_layout Subsection* -LFUN_SPECIALCHAR_INSERT +LFUN_BUFFER_EXPORT \end_layout - \begin_layout Description -Action Inserts various characters into the document. +Action Exports the current buffer (document) to the given format. \end_layout - \begin_layout Description -Syntax specialchar-insert +Syntax buffer-export [] \end_layout - \begin_layout Description -Params : hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen -tence, menu-separator. -\end_layout +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 JSpitzm, 6 Dec 2007 +Origin Lgb, 29 Jul 1997 \end_layout \begin_layout Subsection* -LFUN_SCRIPT_INSERT +LFUN_BUFFER_EXPORT_AS \end_layout - \begin_layout Description -Action Inserts a subscript or superscript inset. +Action Opens a dialog for exporting the current buffer. \end_layout - \begin_layout Description -Syntax script-insert +Syntax buffer-export-as [] \end_layout - \begin_layout Description -Params : subscript|superscript +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. \end_layout - \begin_layout Description -Origin Georg, 23 Nov 2010 +Sample buffer-export-as pdf2 +\end_layout +\begin_layout Description +Origin tommaso, 6 Oct 2011 \end_layout \begin_layout Subsection* -LFUN_APPENDIX +LFUN_BUFFER_EXPORT_CUSTOM \end_layout - \begin_layout Description -Action Start (or remove) Appendix on the given cursor position. +Action Exports the current buffer (document) from the given format using the given command on it. \end_layout - \begin_layout Description -Syntax appendix +Syntax buffer-export-custom \end_layout - \begin_layout Description -Origin ettrich, 5 May 1998 -\end_layout +Params format to start from (LyX will care to produce such intermediate file). +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_INDEX_INSERT + this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file. \end_layout - \begin_layout Description -Action Inserts Index entry. +Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps \end_layout - \begin_layout Description -Notion It automatically takes the word on the cursor position. +Origin leeming, 27 Mar 2004 \end_layout +\begin_layout Subsection* +LFUN_BUFFER_FORALL +\end_layout \begin_layout Description -Syntax index-insert [] +Action Applies a command to all non-hidden buffers. \end_layout - \begin_layout Description -Params : name of the index, if multiple indices are defined. - With an empty argument, the default index is selected. +Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window. \end_layout - \begin_layout Description -Origin leeming, 3 Aug 2000 +Syntax buffer-forall \end_layout - -\begin_layout Subsection* -LFUN_INDEX_PRINT +\begin_layout Description +Params : The command to be applied to the buffers. \end_layout - \begin_layout Description -Action Inserts list of Index entries on a new page. -\end_layout +Sample Close all Notes in buffers: +\begin_inset Newline newline +\end_inset -\begin_layout Description -Syntax index-print [] -\end_layout + buffer-forall inset-forall Note inset-toggle close +\begin_inset Newline newline +\end_inset -\begin_layout Description -Params : name of the index, if multiple indices are defined. - With an empty argument, the default index is selected. -\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 Lgb, 27 Feb 1997 +Origin scottkostyshak, 20 Jul 2012 \end_layout \begin_layout Subsection* -LFUN_IPA_INSERT +LFUN_BUFFER_IMPORT \end_layout - \begin_layout Description -Action Inserts an IPA inset. +Action Import a given file as a lyx document. \end_layout - \begin_layout Description -Syntax ipa-insert +Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats. \end_layout - \begin_layout Description -Origin spitz, 05 Mar 2012 +Syntax buffer-import [] +\end_layout +\begin_layout Description +Origin Asger, 24 Jul 1998 \end_layout \begin_layout Subsection* -LFUN_IN_IPA +LFUN_BUFFER_LANGUAGE \end_layout - \begin_layout Description -Action Only active in IPA inset. +Action Set language of the current document. \end_layout - \begin_layout Description -Notion Dummy function which is only active in a IPA inset. - It's used to toggle the IPA toolbar if the cursor moves into an IPA inset. +Syntax buffer-language \end_layout - \begin_layout Description -Syntax in-ipa +Params : language name. See lib/languages for list. \end_layout - \begin_layout Description -Origin spitz, 20 May 2012 +Origin leeming, 30 Mar 2004 \end_layout \begin_layout Subsection* -LFUN_IPAMACRO_INSERT +LFUN_BUFFER_NEW \end_layout - \begin_layout Description -Action Inserts special IPA macros into the document. +Action Creates a new buffer (that is, document) and switches to it. \end_layout - \begin_layout Description -Syntax ipamacro-insert +Notion Implicit path can be set in Preferences dialog. \end_layout - \begin_layout Description -Params : tone-falling, tone-rising, tone-high-rising, tone-low-rising, - tone-high-rising-falling, deco bottomtiebar, deco toptiebar. +Syntax buffer-new [] \end_layout - \begin_layout Description -Origin JSpitzm, 22 Aug 2012 +Params : filename of created file with absolute path. \end_layout \begin_layout Subsection* -LFUN_NOMENCL_INSERT +LFUN_BUFFER_NEW_TEMPLATE \end_layout - \begin_layout Description -Action Inserts Nomenclature entry. +Action Creates a new buffer (that is, document) from a template. \end_layout - \begin_layout Description -Notion It automatically takes the word on the cursor position if no symbol - is given. +Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog. \end_layout - \begin_layout Description -Syntax nomencl-insert [] +Syntax buffer-new-template [] \end_layout - \begin_layout Description -Origin Ugras, 4 Nov 2006 +Params : filename of created file with absolute path. \end_layout \begin_layout Subsection* -LFUN_NOMENCLATURE_PRINT +LFUN_BUFFER_NEXT \end_layout - \begin_layout Description -Action Inserts list of Nomenclature entries. +Action Switch to the next opened document. \end_layout - \begin_layout Description -Syntax nomenclature-print +Notion Note that this does not necessarily mean next in tabbar (for full list see View menu). \end_layout - \begin_layout Description -Origin Ugras, 4 Nov 2006 +Syntax buffer-next \end_layout \begin_layout Subsection* -LFUN_NOTE_INSERT +LFUN_BUFFER_PARAMS_APPLY +\end_layout +\begin_layout Description +Action Apply the given settings to the current document. \end_layout - \begin_layout Description -Action Inserts Note on the current cursor position, move selection inside - the inset. +Syntax buffer-params-apply [] \end_layout - \begin_layout Description -Syntax note-insert [] +Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. \end_layout - \begin_layout Description -Params : default: Note +Origin leeming, 30 Mar 2004 \end_layout \begin_layout Subsection* -LFUN_NOTE_NEXT +LFUN_BUFFER_PREVIOUS \end_layout - \begin_layout Description -Action Moves the cursor to the beginning of next Note inset. +Action Switch to the previous opened document. \end_layout - \begin_layout Description -Syntax note-next +Syntax buffer-previous \end_layout \begin_layout Subsection* -LFUN_PHANTOM_INSERT +LFUN_BUFFER_PRINT \end_layout - \begin_layout Description -Action Inserts phantom on the current cursor position, move selection inside - the inset. +Action Prints the current document. \end_layout - \begin_layout Description -Syntax phantom-insert [] +Notion Many settings can be given via the preferences dialog. \end_layout - \begin_layout Description -Params : default: Phantom +Syntax buffer-print \end_layout - \begin_layout Description -Origin uwestoehr, 30 Jan 2009 -\end_layout - -\begin_layout Subsection* -LFUN_NEWLINE_INSERT -\end_layout +Params is either "printer" or "file". +\begin_inset Newline newline +\end_inset -\begin_layout Description -Action Inserts a line break or new line. -\end_layout + is either "default" or file name or printer name. +\begin_inset Newline newline +\end_inset -\begin_layout Description -Syntax newline-insert [] + command ensuring the printing job. \end_layout - \begin_layout Description -Params : default: newline +Sample buffer-print file "/trash/newfile1.ps" "dvips" \end_layout - \begin_layout Description -Origin JSpitzm, 25 Mar 2008 +Origin leeming, 28 Mar 2004 \end_layout \begin_layout Subsection* -LFUN_ESCAPE +LFUN_BUFFER_RELOAD \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. +Action Reverts opened document. \end_layout - \begin_layout Description -Syntax escape +Syntax buffer-reload \end_layout - \begin_layout Description -Origin Lgb, 17 May 2001 +Origin Asger, 2 Feb 1997 \end_layout \begin_layout Subsection* -LFUN_DOWN +LFUN_BUFFER_SAVE_AS_DEFAULT \end_layout - \begin_layout Description -Action Moves the cursor one line in downward direction. +Action Save the current document settings as default. \end_layout - \begin_layout Description -Syntax down +Notion The file will will be saved into ~/.lyx/templates/defaults.lyx . \end_layout - -\begin_layout Subsection* -LFUN_UP +\begin_layout Description +Syntax buffer-save-as-default [] \end_layout - \begin_layout Description -Action Moves the cursor one line in upward direction. +Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. \end_layout - \begin_layout Description -Syntax up +Origin leeming, 30 Mar 2004 \end_layout \begin_layout Subsection* -LFUN_DOWN_SELECT +LFUN_BUFFER_SWITCH \end_layout - \begin_layout Description -Action Moves the cursor one line in downward direction adding the current - position to the selection. +Action Display and switch to the given buffer. \end_layout - \begin_layout Description -Syntax down-select +Syntax buffer-switch +\end_layout +\begin_layout Description +Params : path and filename of already opened (but possibly hidden) document which is to be shown. \end_layout \begin_layout Subsection* -LFUN_UP_SELECT +LFUN_BUFFER_TOGGLE_COMPRESSION \end_layout - \begin_layout Description -Action Moves the cursor one line in upward direction adding the current - position to the selection. +Action Toggles compression of the current document on/off. \end_layout - \begin_layout Description -Syntax up-select +Syntax buffer-toggle-compression +\end_layout +\begin_layout Description +Origin bpeng, 27 Apr 2006 \end_layout \begin_layout Subsection* -LFUN_SCREEN_DOWN +LFUN_BUFFER_TOGGLE_OUTPUT_SYNC \end_layout - \begin_layout Description -Action Moves the cursor one page in downward direction. +Action Toggles including of resources for forward/reverse search of the given document. \end_layout - \begin_layout Description -Syntax screen-down +Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences. \end_layout - -\begin_layout Subsection* -LFUN_SCREEN_UP -\end_layout - \begin_layout Description -Action Moves the cursor one page in upward direction. +Syntax buffer-toggle-output-sync \end_layout - \begin_layout Description -Syntax screen-up +Origin sanda, 25 May 2010 \end_layout \begin_layout Subsection* -LFUN_SCREEN_DOWN_SELECT +LFUN_BUFFER_TOGGLE_READ_ONLY \end_layout - \begin_layout Description -Action Moves the cursor one screen in downward direction adding the current - position to the selection. +Action Toggle editing mode of the current document between read/write and read-only. \end_layout - \begin_layout Description -Syntax screen-down-select -\end_layout - -\begin_layout Subsection* -LFUN_SCREEN_UP_SELECT +Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking. \end_layout - \begin_layout Description -Action Moves the cursor one page in upward direction adding the current - position to the selection. +Syntax buffer-toggle-read-only \end_layout - \begin_layout Description -Syntax screen-up-select +Origin Lgb, 27 May 1997 \end_layout \begin_layout Subsection* -LFUN_SCROLL +LFUN_BUFFER_UPDATE \end_layout - \begin_layout Description -Action Scroll the buffer view. +Action Exports the current document and put the result into the temporary directory. \end_layout - \begin_layout Description -Notion Only scrolls the screen up or down; does not move the cursor. +Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript). \end_layout - \begin_layout Description -Syntax scroll +Syntax buffer-update [] \end_layout - \begin_layout Description -Params : line|page -\begin_inset Newline newline -\end_inset - -: up|down| +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. \end_layout - \begin_layout Description -Origin Abdel, Dec 27 2007 +Origin Dekel, 5 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_SCREEN_RECENTER +LFUN_BUFFER_VIEW \end_layout - \begin_layout Description -Action Recenters the screen on the current cursor position. +Action Displays current buffer in chosen format. \end_layout - \begin_layout Description -Syntax screen-recenter +Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth. +\end_layout +\begin_layout Description +Syntax buffer-view [] +\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. \end_layout \begin_layout Subsection* -LFUN_SCREEN_SHOW_CURSOR +LFUN_BUFFER_WRITE \end_layout - \begin_layout Description -Action Repositions the screen such that the cursor is visible. +Action Saves the current buffer. \end_layout - \begin_layout Description -Syntax screen-show-cursor +Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned. \end_layout - \begin_layout Description -Origin vfr, 25 Mar 2009 +Syntax buffer-write \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD +LFUN_BUFFER_WRITE_ALL \end_layout - \begin_layout Description -Action Moves the cursor one position logically backwards. +Action Save all changed documents. \end_layout - \begin_layout Description -Notion This is not the action which should be bound to the arrow keys, because - backwards may be left or right, depending on the language. - The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, - which in turn may employ this one. +Syntax buffer-write-all \end_layout - \begin_layout Description -Syntax char-backward +Origin rgh, gpothier 6 Aug 2007 \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD_SELECT +LFUN_BUFFER_WRITE_AS \end_layout - \begin_layout Description -Action Moves the cursor one position logically backwards, adding traversed - position to the selection. +Action Rename and save current buffer. \end_layout - \begin_layout Description -Notion See also LFUN_CHAR_BACKWARD. +Syntax buffer-write-as \end_layout - \begin_layout Description -Syntax char-backward-select +Params : New name of the buffer/file. A relative path is with respect to the original location of the buffer/file. \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_BACKWARD +LFUN_BUFFER_ZOOM_IN \end_layout - \begin_layout Description -Action Deletes one character in the backward direction (usually the "BackSpace" - key). +Action Increases the zoom of the screen fonts. \end_layout - \begin_layout Description -Syntax char-delete-backward -\end_layout - -\begin_layout Subsection* -LFUN_CHAR_DELETE_FORWARD +Syntax buffer-zoom-in [] \end_layout - \begin_layout Description -Action Deletes one character in the backward direction (usually the "Delete" - key). +Params : The zoom in %, the default is 20. \end_layout - \begin_layout Description -Syntax char-delete-forward +Origin vfr, 30 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD +LFUN_BUFFER_ZOOM_OUT \end_layout - \begin_layout Description -Action Moves the cursor one position logically forward. +Action Decreases the zoom of the screen fonts. \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 buffer-zoom-out [] \end_layout - \begin_layout Description -Syntax char-forward +Params : The zoom in %, the default is 20. +\end_layout +\begin_layout Description +Origin vfr, 30 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD_SELECT +LFUN_BUILD_PROGRAM \end_layout - \begin_layout Description -Action Moves the cursor one position logically forward, adding traversed - position to the selection. +Action Generates the code (literate programming). \end_layout - \begin_layout Description -Notion See also LFUN_CHAR_FORWARD. -\end_layout +Notion Latex file with extension +\backslash +literate_extension is generated. Then LyX invokes +\backslash +build_command (with a default of ``make'') to generate the code and +\backslash +build_error_filter to process the compilation error messages. +\begin_inset Newline newline +\end_inset + +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 char-forward-select +Syntax build-program \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT +LFUN_CALL \end_layout - \begin_layout Description -Action Moves the cursor one position "to the left". +Action Executes a command defined in a .def file. \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 +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 char-left +Syntax call \end_layout - -\begin_layout Subsection* -LFUN_CHAR_LEFT_SELECT +\begin_layout Description +Params : Name of the command that must be called. \end_layout - \begin_layout Description -Action Moves the cursor one position "to the left", adding traversed position - to the selection. +Origin broider, 2 Oct 2007 \end_layout +\begin_layout Subsection* +LFUN_CANCEL +\end_layout \begin_layout Description -Notion See also LFUN_CHAR_LEFT for exact details of the movement. +Action Cancels sequence prepared by LFUN_META_PREFIX . \end_layout - \begin_layout Description -Syntax char-left-select +Syntax cancel \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT +LFUN_CAPTION_INSERT \end_layout - \begin_layout Description -Action Moves the cursor one position "to the right". +Action Inserts a caption inset. \end_layout - \begin_layout Description -Notion This is the action which should be taken when the "right" key is - pressed. - Generally, it moves the cursor one position to the right. - However, in Bidi text this become slightly more complicated, and there - are different modes of cursor movement. - In "visual mode", this moves right, plain and simple. - In "logical mode", movement is logically forward in LTR paragraphs, and - logically backwards in RTL paragraphs. +Syntax caption-insert \end_layout - \begin_layout Description -Syntax char-right +Origin Lgb, 18 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT_SELECT +LFUN_CELL_BACKWARD \end_layout - \begin_layout Description -Action Moves the cursor one position "to the right", adding traversed position - to the selection. +Action Moves the cursor to the previous cell inside the table. \end_layout - \begin_layout Description -Notion See also LFUN_CHAR_RIGHT for exact details of the movement. +Syntax cell-backward \end_layout - \begin_layout Description -Syntax char-right-select +Origin Jug, 22 May 2000 \end_layout \begin_layout Subsection* -LFUN_WORD_BACKWARD -\end_layout - -\begin_layout Description -Action Moves the cursor to the logically previous beginning of a word. +LFUN_CELL_FORWARD \end_layout - \begin_layout Description -Notion This is not the action which should be bound to the arrow keys, because - backwards may be left or right, depending on the language. - The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, - which in turn may employ this one. +Action Moves the cursor to the next cell inside the table. \end_layout - \begin_layout Description -Syntax word-backward +Syntax cell-forward \end_layout \begin_layout Subsection* -LFUN_WORD_BACKWARD_SELECT +LFUN_CELL_SPLIT \end_layout - \begin_layout Description -Action Moves the cursor to the logically previous beginning of a word, adding - the logically traversed text to the selection. +Action Splits cell and shifts right part to the next cell (inside the math grid). \end_layout - \begin_layout Description -Notion See also LFUN_WORD_BACKWARD. +Syntax cell-split \end_layout - \begin_layout Description -Syntax word-backward-select +Origin Ale, 15 May 1997 \end_layout \begin_layout Subsection* -LFUN_WORD_DELETE_BACKWARD +LFUN_CHANGES_MERGE \end_layout - \begin_layout Description -Action Deletes characters to the beginning of the word (usually the "C+BackSpace -" key). +Action Open change tracking dialog for merging and moves the cursor to the position of the next change. \end_layout - \begin_layout Description -Syntax word-delete-backward +Syntax changes-merge +\end_layout +\begin_layout Description +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_WORD_DELETE_FORWARD +LFUN_CHANGES_OUTPUT \end_layout - \begin_layout Description -Action Deletes characters to the end of the word (usually the "C+Delete" - key). +Action Toggles showing of change tracking in typesetted output. \end_layout - \begin_layout Description -Syntax word-delete-forward -\end_layout - -\begin_layout Subsection* -LFUN_WORD_FIND_FORWARD +Syntax changes-output \end_layout - \begin_layout Description -Action Search for a given string in forward direction. +Origin jspitzm, 21 Jan 2005 \end_layout +\begin_layout Subsection* +LFUN_CHANGES_TRACK +\end_layout \begin_layout Description -Notion Case sensitive, match words. - If no argument given, last search repeated. +Action Toggles change tracking to on/off. \end_layout - \begin_layout Description -Syntax word-find-forward [] +Syntax changes-track \end_layout - \begin_layout Description -Origin Etienne, 16 Feb 1998 +Origin levon, 1 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_WORD_FIND_BACKWARD +LFUN_CHANGE_ACCEPT \end_layout - \begin_layout Description -Action Search for a given string in backward direction. +Action Accepts tracked change inside the selection. \end_layout - \begin_layout Description -Notion Case sensitive, match words. - If no argument given, last search repeated. +Syntax change-accept \end_layout - \begin_layout Description -Syntax word-find-backward [] +Origin Levon, 16 Oct 2002 \end_layout +\begin_layout Subsection* +LFUN_CHANGE_NEXT +\end_layout \begin_layout Description -Origin Etienne, 20 Feb 1998 +Action Moves the cursor to the position of the next change of the change tracking records. \end_layout - -\begin_layout Subsection* -LFUN_WORD_FIND +\begin_layout Description +Syntax change-next \end_layout - \begin_layout Description -Action Search for next occurrence of a string. +Origin schmitt, 4 Oct 2006 \end_layout +\begin_layout Subsection* +LFUN_CHANGE_PREVIOUS +\end_layout \begin_layout Description -Syntax word-find [] +Action Moves the cursor to the position of the previous change of the change tracking records. \end_layout - \begin_layout Description -Params : data encoded from Find dialog (see lyx::find2string()). - If no parameter is given, search with last find-dialog data is used for - search (i.e. - find-next). +Syntax change-previous \end_layout - \begin_layout Description -Origin Andre, Jan 7 2004 +Origin vfr, 4 Apr 2009 \end_layout \begin_layout Subsection* -LFUN_WORD_REPLACE +LFUN_CHANGE_REJECT \end_layout - \begin_layout Description -Action Replace a string in the document. +Action Rejects tracked change inside the selection. \end_layout - \begin_layout Description -Syntax word-replace [] -\end_layout - -\begin_layout Description -Params : data is of the form " -\begin_inset Newline newline -\end_inset - - -\begin_inset Newline newline -\end_inset - - " +Syntax change-reject \end_layout - \begin_layout Description -Origin Andre, Jan 7 2004 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_WORD_FINDADV -\end_layout - -\begin_layout Description -Action Search for next occurrence of a pattern. +LFUN_CHARS_TRANSPOSE \end_layout - \begin_layout Description -Syntax word-findadv [] +Action Transposes the character at the cursor with the one before it. \end_layout - \begin_layout Description -Params : data encoded from FindAdv dialog (see lyx::findadv2string()). - If no parameter is given, search with last find-dialog data is used for - search (i.e. - find-next). +Syntax chars-transpose \end_layout - \begin_layout Description -Origin Tommaso, Nov 15 2007 +Origin Lgb, 25 Apr 2001 \end_layout \begin_layout Subsection* -LFUN_WORD_FORWARD +LFUN_CHAR_BACKWARD \end_layout - \begin_layout Description -Action Moves the cursor to the logically next beginning of a word. +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 - forward may be left or right, depending on the language. - The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions, - which in turn may employ this one. +Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one. \end_layout - \begin_layout Description -Syntax word-forward +Syntax char-backward \end_layout \begin_layout Subsection* -LFUN_WORD_FORWARD_SELECT +LFUN_CHAR_BACKWARD_SELECT \end_layout - \begin_layout Description -Action Moves the cursor to the logically next beginning of a word, adding - the logically traversed text to the selection. +Action Moves the cursor one position logically backwards, adding traversed position to the selection. \end_layout - \begin_layout Description -Notion See also LFUN_WORD_FORWARD. +Notion See also LFUN_CHAR_BACKWARD. \end_layout - \begin_layout Description -Syntax word-forward-select +Syntax char-backward-select \end_layout \begin_layout Subsection* -LFUN_WORD_LEFT +LFUN_CHAR_DELETE_BACKWARD \end_layout - \begin_layout Description -Action Moves the cursor to the next beginning of a word "on the left". +Action Deletes one character in the backward direction (usually the "BackSpace" key). \end_layout - \begin_layout Description -Notion This is the action which should be taken when the (e.g., ctrl-) "left" - key is pressed. - Generally, it moves the cursor to the next beginning of a word on the left. - However, in Bidi text this become slightly more complicated, and there - are different modes of cursor movement. - In "visual mode", this moves left, plain and simple. - In "logical mode", movement is logically forward in RTL paragraphs, and - logically backwards in LTR paragraphs. +Syntax char-delete-backward \end_layout +\begin_layout Subsection* +LFUN_CHAR_DELETE_FORWARD +\end_layout \begin_layout Description -Syntax word-left +Action Deletes one character in the backward direction (usually the "Delete" key). \end_layout - \begin_layout Description -Origin dov, 28 Oct 2007 +Syntax char-delete-forward \end_layout \begin_layout Subsection* -LFUN_WORD_LEFT_SELECT -\end_layout - -\begin_layout Description -Action Moves the cursor to the next beginning of a word "on the left", adding - *logically* traversed text to the selection. +LFUN_CHAR_FORWARD \end_layout - \begin_layout Description -Notion See also LFUN_WORD_LEFT for exact details of the movement. +Action Moves the cursor one position logically forward. \end_layout - \begin_layout Description -Syntax word-left-select +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 dov, 28 Oct 2007 +Syntax char-forward \end_layout \begin_layout Subsection* -LFUN_WORD_RIGHT -\end_layout - -\begin_layout Description -Action Moves the cursor to the next beginning of a word "on the right". +LFUN_CHAR_FORWARD_SELECT \end_layout - \begin_layout Description -Notion This is the action which should be taken when the (e.g., ctrl-) "right" - key is pressed. - Generally, it moves the cursor to the next beginning of a word on the right. - However, in Bidi text this become slightly more complicated, and there - are different modes of cursor movement. - In "visual mode", this moves right, plain and simple. - In "logical mode", movement is logically forward in LTR paragraphs, and - logically backwards in RTL paragraphs. +Action Moves the cursor one position logically forward, adding traversed position to the selection. \end_layout - \begin_layout Description -Syntax word-right +Notion See also LFUN_CHAR_FORWARD. \end_layout - \begin_layout Description -Origin dov, 28 Oct 2007 +Syntax char-forward-select \end_layout \begin_layout Subsection* -LFUN_WORD_RIGHT_SELECT -\end_layout - -\begin_layout Description -Action Moves the cursor to the next beginning of a word "on the right", - adding *logically* traversed text to the selection. +LFUN_CHAR_LEFT \end_layout - \begin_layout Description -Notion See also LFUN_WORD_RIGHT for exact details of the movement. +Action Moves the cursor one position "to the left". \end_layout - \begin_layout Description -Syntax word-right-select +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 dov, 28 Oct 2007 +Syntax char-left \end_layout \begin_layout Subsection* -LFUN_WORD_SELECT +LFUN_CHAR_LEFT_SELECT \end_layout - \begin_layout Description -Action Puts the word where the cursor stands into the selection. +Action Moves the cursor one position "to the left", adding traversed position to the selection. \end_layout - \begin_layout Description -Syntax word-select +Notion See also LFUN_CHAR_LEFT for exact details of the movement. \end_layout - \begin_layout Description -Origin Andre, 11 Sep 2002 +Syntax char-left-select \end_layout \begin_layout Subsection* -LFUN_WORD_CAPITALIZE +LFUN_CHAR_RIGHT \end_layout - \begin_layout Description -Action Capitalizes the words in the selection (i.e. - the first letters) or the letter on the cursor position. +Action Moves the cursor one position "to the right". \end_layout - \begin_layout Description -Syntax word-capitalize +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_WORD_UPCASE +LFUN_CHAR_RIGHT_SELECT \end_layout - \begin_layout Description -Action Change the words in the selection or from the cursor position to - the end of word to the upper case. +Action Moves the cursor one position "to the right", adding traversed position to the selection. \end_layout - \begin_layout Description -Syntax word-upcase +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_WORD_LOWCASE +LFUN_CITATION_INSERT \end_layout - \begin_layout Description -Action Change the words in the selection or from the cursor position to - the end of word to the lower case. +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 -Syntax word-lowcase +Origin AAS, 97-02-23 \end_layout \begin_layout Subsection* -LFUN_SPELLING_ADD +LFUN_CLIPBOARD_PASTE \end_layout - \begin_layout Description -Action Add the word under the cursor to the respective spell checker dictionary. +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 -Syntax spelling-add [] [] +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 -Params : word to add : language name (see file languages) +Syntax clipboard-paste [] \end_layout - \begin_layout Description -Origin JSpitzm, 18 Jan 2010 +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_SPELLING_IGNORE +LFUN_CLIPBOARD_PASTE_SIMPLE \end_layout - \begin_layout Description -Action Let the spell checker ignore the word under the cursor in the current - session for the given language. +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 spelling-ignore [] [] +Syntax clipboard-paste-simple [] \end_layout - \begin_layout Description -Params : word to ignore : language name (see file languages) +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 -Origin JSpitzm, 18 Jan 2010 +Action Runs the first listed command that is enabled. \end_layout - -\begin_layout Subsection* -LFUN_SPELLING_REMOVE +\begin_layout Description +Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context. \end_layout - \begin_layout Description -Action Remove the word under the cursor from the respective spell checker - dictionary. +Syntax command-alternatives \end_layout - \begin_layout Description -Syntax spelling-remove [] [] +Params : Sequence of commands separated by semicolons. \end_layout - \begin_layout Description -Params : word to remove : language name (see file languages) +Sample command-alternatives completion-accept;cell-forward \end_layout - \begin_layout Description -Origin SWitt, 28 July 2010 +Origin rgh, 24 September 2008 \end_layout \begin_layout Subsection* -LFUN_SPELLING_CONTINUOUSLY +LFUN_COMMAND_EXECUTE \end_layout - \begin_layout Description -Action Toggle continuous spell checking. +Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar. \end_layout - \begin_layout Description -Syntax spelling-continuously +Notion Usually bound to M-x shortcut. \end_layout - \begin_layout Description -Origin vfr, 24 March 2013 +Syntax command-execute \end_layout \begin_layout Subsection* -LFUN_THESAURUS_ENTRY +LFUN_COMMAND_PREFIX \end_layout - \begin_layout Description -Action Look up thesaurus entries with respect to the word under the cursor. +Action Return the current key sequence and available options as a string. \end_layout - \begin_layout Description -Syntax thesaurus-entry [] [lang=] -\end_layout +Notion No options are added if no current map exists. +\begin_inset Newline newline +\end_inset -\begin_layout Description -Params : word to look up : language (see file languages) +This is probably usable only with connection to lyxserver. \end_layout - \begin_layout Description -Origin Levon, 20 Jul 2001 +Syntax command-prefix \end_layout \begin_layout Subsection* -LFUN_BUFFER_BEGIN +LFUN_COMMAND_SEQUENCE \end_layout - \begin_layout Description -Action Move the cursor to the beginning of the document. +Action Run more commands (LFUN and its parameters) in a sequence. \end_layout - \begin_layout Description -Syntax buffer-begin +Syntax command-sequence \end_layout - -\begin_layout Subsection* -LFUN_BUFFER_BEGIN_SELECT +\begin_layout Description +Params : Sequence of commands separated by semicolons. \end_layout - \begin_layout Description -Action Move the cursor to the beginning of the document adding the traversed - text to the selection. +Sample command-sequence cut; ert-insert; self-insert +\backslash +; paste; self-insert {}; inset-toggle; \end_layout - \begin_layout Description -Syntax buffer-begin-select +Origin Andre, 11 Nov 1999 \end_layout \begin_layout Subsection* -LFUN_BUFFER_END +LFUN_COMPLETION_ACCEPT \end_layout - \begin_layout Description -Action Move the cursor to the end of the document. +Action Accept suggested completion. \end_layout - \begin_layout Description -Syntax buffer-end +Syntax completion-accept +\end_layout +\begin_layout Description +Origin sanda, Sep 08 2008 \end_layout \begin_layout Subsection* -LFUN_BUFFER_END_SELECT +LFUN_COMPLETION_CANCEL +\end_layout +\begin_layout Description +Action Try to cancel completion, either the popup or the inline completion. \end_layout - \begin_layout Description -Action Move the cursor to the end of the document adding the traversed text - to the selection. +Syntax completion-cancel \end_layout - \begin_layout Description -Syntax buffer-end-select +Origin sts, Sep 07 2008 \end_layout \begin_layout Subsection* -LFUN_INSET_BEGIN +LFUN_COMPLETION_COMPLETE \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 +Action Try to complete the word or command at the cursor position. \end_layout - \begin_layout Description -Syntax inset-begin +Syntax complete \end_layout - \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_INSET_BEGIN_SELECT +LFUN_COMPLETION_INLINE \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). +Action Show the inline completion at the cursor position. \end_layout - \begin_layout Description -Syntax inset-begin-select +Syntax completion-inline \end_layout - \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_INSET_END +LFUN_COMPLETION_POPUP \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 +Action Show the completion popup at the cursor position. \end_layout - \begin_layout Description -Syntax inset-end +Syntax completion-popup \end_layout - \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_INSET_END_SELECT +LFUN_COPY \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). +Action Copies the current selection to the clipboard. \end_layout - \begin_layout Description -Syntax inset-end-select +Syntax copy \end_layout +\begin_layout Subsection* +LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE +\end_layout \begin_layout Description -Origin lasgouttes, 16 Mar 2009 +Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement. \end_layout - -\begin_layout Subsection* -LFUN_INSET_SELECT_ALL +\begin_layout Description +Syntax toggle-cursor-follows-scrollbar \end_layout - \begin_layout Description -Action Selects all contents of an inset. +Origin ARRae, 2 Dec 1997 \end_layout +\begin_layout Subsection* +LFUN_CUT +\end_layout \begin_layout Description -Syntax inset-select-all +Action Cuts to the clipboard. \end_layout - \begin_layout Description -Origin vfr, 22 Aug 2009 +Syntax cut \end_layout \begin_layout Subsection* -LFUN_SECTION_SELECT +LFUN_DATE_INSERT \end_layout - \begin_layout Description -Action Selects the whole section. +Action Inserts the current date. \end_layout - \begin_layout Description -Notion The cursor should be in a section heading before calling this lfun. +Syntax date-insert [] \end_layout - \begin_layout Description -Syntax section-select +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 vfr, 05 May 2009 +Origin jdblair, 31 Jan 2000 \end_layout \begin_layout Subsection* -LFUN_LINE_BEGIN +LFUN_DEBUG_LEVEL_SET \end_layout - \begin_layout Description -Action Move the cursor to the beginning of the (screen) line. +Action Set debug output level. \end_layout - \begin_layout Description -Syntax line-begin -\end_layout - -\begin_layout Subsection* -LFUN_LINE_BEGIN_SELECT +Syntax debug-level-set \end_layout - \begin_layout Description -Action Move the cursor to the beginning of the (screen) line adding the - traversed text to the selection. +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 -Syntax line-begin-select +Origin sanda, 28 Dec 2009 \end_layout \begin_layout Subsection* -LFUN_LINE_END +LFUN_DEPTH_DECREMENT \end_layout - \begin_layout Description -Action Move the cursor to the end of the (screen) line. +Action Decrease the nesting depth of the (selected) paragraph(s) inside lists. \end_layout - \begin_layout Description -Syntax line-end +Syntax depth-decrement \end_layout \begin_layout Subsection* -LFUN_LINE_END_SELECT +LFUN_DEPTH_INCREMENT \end_layout - \begin_layout Description -Action Move the cursor to the end of the (screen) line adding the traversed - text to the selection. +Action Increase the nesting depth of the (selected) paragraph(s) inside lists. \end_layout - \begin_layout Description -Syntax line-end-select +Syntax depth-increment \end_layout \begin_layout Subsection* -LFUN_LINE_DELETE +LFUN_DIALOG_DISCONNECT_INSET \end_layout - \begin_layout Description -Action Deletes the letters to the end of the (screen) line or deletes the - selection. +Action Closes opened connection to opened inset. \end_layout - \begin_layout Description -Syntax line-delete-forward -\end_layout - -\begin_layout Subsection* -LFUN_COPY +Notion Connection is used for apply functions. \end_layout - \begin_layout Description -Action Copies the current selection to the clipboard. +Syntax dialog-disconnect-inset \end_layout - \begin_layout Description -Syntax copy +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_CUT +LFUN_DIALOG_HIDE \end_layout - \begin_layout Description -Action Cuts to the clipboard. +Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW . \end_layout - \begin_layout Description -Syntax cut +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_PASTE +LFUN_DIALOG_SHOW \end_layout - \begin_layout Description -Action Pastes material (text or picture) from the active clipboard. +Action Shows hidden dialog or creates new one for a given function/inset settings etc. \end_layout - \begin_layout Description -Syntax paste [|] +Syntax dialog-show [] \end_layout - \begin_layout Description -Params : emf|pdf|png|jpeg|linkback|wmf|latex|html +Params : aboutlyx|bibitem|bibtex|box|branch|changes|character|citation| \begin_inset Newline newline \end_inset -: number of the selection in the internal clipboard stack to be pasted. -\end_layout +compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float| +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_CLIPBOARD_PASTE -\end_layout +graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter| +\begin_inset Newline newline +\end_inset -\begin_layout Description -Action Pastes text from the active clipboard. -\end_layout +mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs| +\begin_inset Newline newline +\end_inset -\begin_layout Description -Syntax clipboard-paste [] -\end_layout +print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate| +\begin_inset Newline newline +\end_inset -\begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. - "Join lines". -\end_layout +thesaurus|texinfo|toc|view-source|vspace|wrap| +\begin_inset Newline newline +\end_inset + +: latexlog|vclog +\begin_inset Newline newline +\end_inset +: data, usually settings for the given dialog. Use debug mode for the details. +\end_layout \begin_layout Description -Origin Georg, 10 Jul 2006 +Origin leeming, 17 Jun 2003 \end_layout \begin_layout Subsection* -LFUN_PRIMARY_SELECTION_PASTE +LFUN_DIALOG_SHOW_NEW_INSET \end_layout - \begin_layout Description -Action Pastes the currently selected text. +Action Shows hidden dialog or create new one for a given inset settings etc. \end_layout - \begin_layout Description -Notion Primary selection mechanism is linux-only thing. +Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset. \end_layout - \begin_layout Description -Syntax primary-selection-paste [] +Syntax dialog-show-new-inset [] \end_layout - \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. - "Join lines". +Params See LFUN_DIALOG_SHOW . +\end_layout +\begin_layout Description +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_SELECTION_PASTE +LFUN_DIALOG_TOGGLE \end_layout - \begin_layout Description -Action Pastes the internal selection text in permanent selection. +Action Toggles dialog between showed/hidden state. \end_layout - \begin_layout Description -Notion Created in order to have middle mouse button pasting correct (bound - to command-alternatives selection-paste ; primary-selection-paste paragraph). +Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE . \end_layout - \begin_layout Description -Syntax selection-paste +Syntax dialog-toggle [] \end_layout - \begin_layout Description -Origin lasgouttes, 14 Jan 2009 +Params See LFUN_DIALOG_SHOW . +\end_layout +\begin_layout Description +Origin JSpitzm, 30 Apr 2007 \end_layout \begin_layout Subsection* -LFUN_CLIPBOARD_PASTE_SIMPLE +LFUN_DIALOG_UPDATE \end_layout - \begin_layout Description -Action Pastes simple unformatted text from the active clipboard. +Action Updates the dialog values from the inset/paragraph/document. \end_layout - \begin_layout Description -Syntax clipboard-paste-simple [] +Syntax dialog-update \end_layout +\begin_layout Description +Params : paragraph|prefs| +\begin_inset Newline newline +\end_inset +: inset name +\end_layout \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. - "Join lines". +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_UNDO +LFUN_DOWN \end_layout - \begin_layout Description -Action Undoes the last edit. +Action Moves the cursor one line in downward direction. \end_layout - \begin_layout Description -Syntax undo +Syntax down \end_layout \begin_layout Subsection* -LFUN_REDO +LFUN_DOWN_SELECT \end_layout - \begin_layout Description -Action Redoes the last thing undone. +Action Moves the cursor one line in downward direction adding the current position to the selection. \end_layout - \begin_layout Description -Syntax redo +Syntax down-select \end_layout \begin_layout Subsection* -LFUN_REPEAT +LFUN_DROP_LAYOUTS_CHOICE \end_layout - \begin_layout Description -Action Repeat the given command. +Action Displays list of layout choices. \end_layout - \begin_layout Description -Syntax repeat +Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. \end_layout - \begin_layout Description -Origin Andre, 27 Oct 2003 +Syntax drop-layouts-choice \end_layout \begin_layout Subsection* -LFUN_CHARS_TRANSPOSE +LFUN_ENVIRONMENT_SPLIT \end_layout - \begin_layout Description -Action Transposes the character at the cursor with the one before it. +Action Splits the current environment with a Separator. \end_layout - \begin_layout Description -Syntax chars-transpose +Syntax environment-split [outer] \end_layout - \begin_layout Description -Origin Lgb, 25 Apr 2001 +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_DEPTH_DECREMENT +LFUN_ERT_INSERT \end_layout - \begin_layout Description -Action Decrease the nesting depth of the (selected) paragraph(s) inside - lists. +Action Inserts an ERT inset. \end_layout - \begin_layout Description -Syntax depth-decrement +Syntax ert-insert +\end_layout +\begin_layout Description +Origin Jug, 18 Feb 2000 \end_layout \begin_layout Subsection* -LFUN_DEPTH_INCREMENT +LFUN_ESCAPE \end_layout - \begin_layout Description -Action Increase the nesting depth of the (selected) paragraph(s) inside - lists. +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 depth-increment +Syntax escape +\end_layout +\begin_layout Description +Origin Lgb, 17 May 2001 \end_layout \begin_layout Subsection* -LFUN_FONT_BOLD +LFUN_FILE_INSERT \end_layout - \begin_layout Description -Action Toggles the bold font (selection-wise) using mathbf in math. +Action Inserts another LyX file. \end_layout - \begin_layout Description -Syntax font-bold +Syntax file-insert [] +\end_layout +\begin_layout Description +Params : Filename to be inserted. \end_layout \begin_layout Subsection* -LFUN_FONT_BOLDSYMBOL +LFUN_FILE_INSERT_PLAINTEXT \end_layout - \begin_layout Description -Action Toggles the bold font (selection-wise) using boldsymbol in math. +Action Inserts plain text file. \end_layout - \begin_layout Description -Syntax font-boldsymbol +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_FONT_TYPEWRITER +LFUN_FILE_INSERT_PLAINTEXT_PARA \end_layout - \begin_layout Description -Action Toggles the typewriter family font (selection-wise). +Action Inserts plain text file as paragraph (i.e. join lines). \end_layout - \begin_layout Description -Syntax font-typewriter +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 \end_layout \begin_layout Subsection* -LFUN_FONT_UNDERLINE +LFUN_FILE_OPEN \end_layout - \begin_layout Description -Action Toggles underline in the font (selection-wise). +Action Open LyX document. \end_layout - \begin_layout Description -Syntax font-underline +Syntax file-open [] +\end_layout +\begin_layout Description +Params : Filename to be opened. \end_layout \begin_layout Subsection* -LFUN_FONT_UULINE +LFUN_FINISHED_BACKWARD \end_layout - \begin_layout Description -Action Toggles double underline in the font (selection-wise). +Action Moves the cursor out of the current slice, going backwards. \end_layout - \begin_layout Description -Syntax font-underunderline +Notion See also LFUN_FINISHED_FORWARD. \end_layout +\begin_layout Subsection* +LFUN_FINISHED_FORWARD +\end_layout \begin_layout Description -Origin sanda, 5 May 2009 +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. \end_layout \begin_layout Subsection* -LFUN_FONT_UWAVE +LFUN_FINISHED_LEFT \end_layout - \begin_layout Description -Action Toggles wavy underline in the font (selection-wise). +Action Moves the cursor out of the current slice, going left. \end_layout - \begin_layout Description -Syntax font-underwave +Notion See also LFUN_FINISHED_FORWARD. \end_layout +\begin_layout Subsection* +LFUN_FINISHED_RIGHT +\end_layout \begin_layout Description -Origin sanda, 5 May 2009 +Action Moves the cursor out of the current slice, going right. +\end_layout +\begin_layout Description +Notion See also LFUN_FINISHED_FORWARD \end_layout \begin_layout Subsection* -LFUN_FONT_STRIKEOUT +LFUN_FLEX_INSERT \end_layout - \begin_layout Description -Action Toggles strikeout (strike-through) in the font (selection-wise). +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 +\end_inset + +To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself. +\begin_inset Newline newline +\end_inset +For dissolving the element see LFUN_INSET_DISSOLVE. +\end_layout \begin_layout Description -Syntax font-strikeout +Syntax flex-insert Name \end_layout - \begin_layout Description -Origin sanda, 3 May 2009 +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_FONT_EMPH +LFUN_FLOAT_INSERT \end_layout - \begin_layout Description -Action Toggles the emphasis font style (selection-wise). +Action Inserts a float inset. \end_layout - \begin_layout Description -Syntax font-emph +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_FONT_NOUN +LFUN_FLOAT_LIST_INSERT \end_layout - \begin_layout Description -Action Toggles Noun text style font (selection-wise). +Action Inserts the list of floats in the document. \end_layout - \begin_layout Description -Syntax font-noun +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_FONT_ROMAN +LFUN_FLOAT_WIDE_INSERT \end_layout - \begin_layout Description -Action Toggles Roman family font (selection-wise). +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 +\end_layout \begin_layout Description -Syntax font-roman +Action Toggles the bold font (selection-wise) using mathbf in math. +\end_layout +\begin_layout Description +Syntax font-bold \end_layout \begin_layout Subsection* -LFUN_FONT_SANS +LFUN_FONT_BOLDSYMBOL +\end_layout +\begin_layout Description +Action Toggles the bold font (selection-wise) using boldsymbol in math. +\end_layout +\begin_layout Description +Syntax font-boldsymbol \end_layout +\begin_layout Subsection* +LFUN_FONT_DEFAULT +\end_layout \begin_layout Description -Action Toggles Sans Serif family font (selection-wise). +Action Reverts the settings of the font to the default values (selection-wise). +\end_layout +\begin_layout Description +Syntax font-default \end_layout +\begin_layout Subsection* +LFUN_FONT_EMPH +\end_layout \begin_layout Description -Syntax font-sans +Action Toggles the emphasis font style (selection-wise). +\end_layout +\begin_layout Description +Syntax font-emph \end_layout \begin_layout Subsection* LFUN_FONT_FRAK \end_layout - \begin_layout Description Action Toggles Fraktur family font (math-mode, selection-wise). \end_layout - \begin_layout Description Syntax font-frak \end_layout - \begin_layout Description Origin vermeer, 10 Jan 2002 \end_layout @@ -2536,43 +2232,55 @@ Origin vermeer, 10 Jan 2002 \begin_layout Subsection* LFUN_FONT_ITAL \end_layout - \begin_layout Description Action Toggles Italics font shape (math-mode, selection-wise). \end_layout - \begin_layout Description Syntax font-ital \end_layout - \begin_layout Description Origin vermeer, 10 Jan 2002 \end_layout \begin_layout Subsection* -LFUN_FONT_DEFAULT +LFUN_FONT_NOUN +\end_layout +\begin_layout Description +Action Toggles Noun text style font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-noun \end_layout +\begin_layout Subsection* +LFUN_FONT_ROMAN +\end_layout \begin_layout Description -Action Reverts the settings of the font to the default values (selection-wise). +Action Toggles Roman family font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-roman \end_layout +\begin_layout Subsection* +LFUN_FONT_SANS +\end_layout \begin_layout Description -Syntax font-default +Action Toggles Sans Serif family font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-sans \end_layout \begin_layout Subsection* LFUN_FONT_SIZE \end_layout - \begin_layout Description Action Sets font size according to lyx format string. \end_layout - \begin_layout Description Syntax font-size \end_layout - \begin_layout Description Params : tiny|scriptsize|footnotesize|small|normal|large|larger| \begin_inset Newline newline @@ -2582,4811 +2290,3506 @@ largest|huge|giant|increase|decrease|default \end_layout \begin_layout Subsection* -LFUN_TEXTSTYLE_APPLY +LFUN_FONT_STATE \end_layout - \begin_layout Description -Action Toggle user-defined (=last-time used) text style. +Action Returns the info about the current font. \end_layout - \begin_layout Description -Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically - triggered when using Text Style dialog. +Syntax font-state \end_layout +\begin_layout Subsection* +LFUN_FONT_STRIKEOUT +\end_layout \begin_layout Description -Syntax textstyle-apply +Action Toggles strikeout (strike-through) in the font (selection-wise). \end_layout - \begin_layout Description -Origin leeming, 12 Mar 2003 +Syntax font-strikeout +\end_layout +\begin_layout Description +Origin sanda, 3 May 2009 \end_layout \begin_layout Subsection* -LFUN_TEXTSTYLE_UPDATE +LFUN_FONT_TYPEWRITER \end_layout - \begin_layout Description -Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP -LY. +Action Toggles the typewriter family font (selection-wise). \end_layout - \begin_layout Description -Syntax textstyle-update +Syntax font-typewriter \end_layout -\begin_layout Description -Params : specifies font atributes, e.g. - family, series, shape, size, emph, noun, underbar, number, color, language, - toggleall. -\begin_inset Newline newline -\end_inset - -Use lyx -dbg action for exact syntax of text-style dialog parameters. +\begin_layout Subsection* +LFUN_FONT_UNDERLINE \end_layout - \begin_layout Description -Origin leeming, 12 Mar 2003 +Action Toggles underline in the font (selection-wise). \end_layout - -\begin_layout Subsection* -LFUN_SCREEN_FONT_UPDATE -\end_layout - \begin_layout Description -Action Update fonts and its metrics. +Syntax font-underline \end_layout +\begin_layout Subsection* +LFUN_FONT_UULINE +\end_layout \begin_layout Description -Notion Automatically called after zoom, dpi, font names, or norm change. +Action Toggles double underline in the font (selection-wise). \end_layout - \begin_layout Description -Syntax screen-font-update +Syntax font-underunderline \end_layout - \begin_layout Description -Origin ARRae, 13 Aug 2000 +Origin sanda, 5 May 2009 \end_layout \begin_layout Subsection* -LFUN_FONT_STATE +LFUN_FONT_UWAVE \end_layout - \begin_layout Description -Action Returns the info about the current font. +Action Toggles wavy underline in the font (selection-wise). \end_layout - \begin_layout Description -Syntax font-state -\end_layout - -\begin_layout Subsection* -LFUN_CITATION_INSERT +Syntax font-underwave \end_layout - \begin_layout Description -Action Inserts citation from loaded citation database. +Origin sanda, 5 May 2009 \end_layout +\begin_layout Subsection* +LFUN_FOOTNOTE_INSERT +\end_layout \begin_layout Description -Syntax citation-insert [[|]] +Action Inserts a footnote inset. \end_layout - \begin_layout Description -Params : Citation (shortcut listed in available citations). -\begin_inset Newline newline -\end_inset - -: text which should appear before citation. +Syntax footnote-insert \end_layout - \begin_layout Description -Origin AAS, 97-02-23 +Origin Jug, 7 Mar 2000 \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_ADD +LFUN_FORWARD_SEARCH \end_layout - \begin_layout Description -Action Adds database, which will be used for bibtex citations. +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 Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX - bibliography) found from the cursor position. +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 bibtex-database-add +Syntax forward-search \end_layout - \begin_layout Description -Origin Ale, 30 May 1997 +Origin sanda, 14 Apr 2010 \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_DEL -\end_layout - -\begin_layout Description -Action Adds database, which will be used for bibtex citations. +LFUN_GRAPHICS_RELOAD \end_layout - \begin_layout Description -Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe -X bibliography) found from the cursor position. +Action Reloads the image if necessary. \end_layout - \begin_layout Description -Syntax bibtex-database-del +Syntax graphics-reload \end_layout - \begin_layout Description -Origin Ale, 30 May 1997 +Origin vfr, 10 Aug 2009 \end_layout \begin_layout Subsection* -LFUN_LAYOUT +LFUN_HELP_OPEN \end_layout - \begin_layout Description -Action Sets the layout (that is, environment) for the current paragraph. +Action Open the given help file according to the language setting. \end_layout - \begin_layout Description -Syntax layout +Syntax help-open [.lyx] \end_layout - \begin_layout Description -Params : the layout to use +Params : any document from (/usr/share/)doc directory. +\end_layout +\begin_layout Description +Origin Jug, 27 Jun 1999 \end_layout \begin_layout Subsection* -LFUN_LAYOUT_PARAGRAPH +LFUN_HYPERLINK_INSERT \end_layout - \begin_layout Description -Action Launches the paragraph settings dialog. +Action Inserts hyperlinks into the document (clickable in pdf output). \end_layout - \begin_layout Description -Syntax layout-paragraph -\end_layout - -\begin_layout Subsection* -LFUN_LAYOUT_TABULAR +Notion Hyperlink target can be set via selection + hyperlink-insert function. \end_layout - \begin_layout Description -Action Launches the tabular settings dialog. +Syntax href-insert [] \end_layout - \begin_layout Description -Syntax layout-tabular +Origin CFO-G, 21 Nov 1997 \end_layout +\begin_layout Subsection* +LFUN_INDEX_INSERT +\end_layout \begin_layout Description -Origin Jug, 31 Jul 2000 +Action Inserts Index entry. \end_layout - -\begin_layout Subsection* -LFUN_DROP_LAYOUTS_CHOICE +\begin_layout Description +Notion It automatically takes the word on the cursor position. \end_layout - \begin_layout Description -Action Displays list of layout choices. +Syntax index-insert [] \end_layout - \begin_layout Description -Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox - allowing for choice of layout. +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 drop-layouts-choice +Origin leeming, 3 Aug 2000 \end_layout \begin_layout Subsection* -LFUN_LAYOUT_MODULES_CLEAR +LFUN_INDEX_PRINT \end_layout - \begin_layout Description -Action Clears the module list. +Action Inserts list of Index entries on a new page. \end_layout - \begin_layout Description -Notion Clears the list of included modules for the current buffer. +Syntax index-print [] \end_layout - \begin_layout Description -Syntax layout-modules-clear +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 rgh, 25 August 2007 +Origin Lgb, 27 Feb 1997 \end_layout \begin_layout Subsection* -LFUN_LAYOUT_MODULE_ADD +LFUN_INFO_INSERT \end_layout - \begin_layout Description -Action Adds a module. +Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. \end_layout - \begin_layout Description -Notion Adds a module to the list of included modules for the current buffer. -\end_layout +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 layout-module-add +Syntax info-insert \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 -Params : the module to be added +Sample command-sequence info-insert buffer path; info-insert buffer name \end_layout - \begin_layout Description -Origin rgh, 25 August 2007 +Origin bpeng, 7 Oct 2007 \end_layout \begin_layout Subsection* -LFUN_LAYOUT_RELOAD +LFUN_INSET_APPLY \end_layout - \begin_layout Description -Action Reloads layout information. +Action Apply data for an inset. \end_layout - \begin_layout Description -Notion Reloads all layout information for the current buffer from disk, - thus recognizing any changes that have been made to layout files on the - fly. - This is intended to be used only by layout developers and should not be - used when one is trying to do actual work. +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 layout-reload +Syntax inset-apply \end_layout - \begin_layout Description -Origin rgh, 3 September 2007 +Params See LFUN_INSET_INSERT . \end_layout \begin_layout Subsection* -LFUN_TEXTCLASS_APPLY +LFUN_INSET_BEGIN \end_layout - \begin_layout Description -Action Sets the text class for the current buffer. +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 textclass-apply +Syntax inset-begin \end_layout - \begin_layout Description -Params : the textclass to set. - Note that this must be the filename, minus the ".layout" extension. +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_TEXTCLASS_LOAD +LFUN_INSET_BEGIN_SELECT \end_layout - \begin_layout Description -Action Loads information for a textclass from disk. +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 textclass-load +Syntax inset-begin-select \end_layout - \begin_layout Description -Params : the textclass to load. - Note that this must be the filename, minus the ".layout" extension. +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_MARK_OFF +LFUN_INSET_COPY_AS \end_layout - \begin_layout Description -Action Disable selecting of text-region. +Action Copies the inset to the clipboard as a certain type. \end_layout - \begin_layout Description -Syntax mark-off +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_MARK_ON +LFUN_INSET_DIALOG_UPDATE \end_layout - \begin_layout Description -Action Enable selecting of text-region. +Action Updates the values inside the dialog from the inset. \end_layout - \begin_layout Description -Notion After enabling you can simply move arrow keys to get selected region. +Notion This is an internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE \end_layout - \begin_layout Description -Syntax mark-on +Params +\end_layout +\begin_layout Description +Origin leeming, 25 Feb 2003 \end_layout \begin_layout Subsection* -LFUN_MARK_TOGGLE +LFUN_INSET_DISSOLVE \end_layout - \begin_layout Description -Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF . +Action Dissolve the current inset into text. \end_layout - \begin_layout Description -Syntax mark-toggle +Syntax inset-dissolve [] \end_layout - \begin_layout Description -Origin Andre, May 5 2006 -\end_layout - -\begin_layout Subsection* -LFUN_MATH_DELIM -\end_layout - -\begin_layout Description -Action Inserts math delimiters (e.g. - parentheses, brackets) enclosing expression. -\end_layout - -\begin_layout Description -Syntax math-delim [] [] -\end_layout - -\begin_layout Description -Params : Delimiters to be used. - Each delimiter can be specified by either a LaTeX name or a valid character. - ( is the default letter. -\end_layout +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 +\end_inset -\begin_layout Description -Sample math-delim { rangle +For values see lyx::InsetLayout::lyxtype_ . \end_layout - \begin_layout Description -Origin Alejandro, 18 Jun 1996 +Origin JSpitz, 7 Aug 2006 \end_layout \begin_layout Subsection* -LFUN_MATH_BIGDELIM +LFUN_INSET_EDIT \end_layout - \begin_layout Description -Action Inserts math fixed size delimiters (e.g. - parentheses, brackets) enclosing expression. +Action Edit the inset at cursor with an external application, if one is attributed. \end_layout - \begin_layout Description -Syntax math-bigdelim +Syntax inset-edit [] \end_layout - \begin_layout Description -Params : bigl/r|Bigl/r|biggl/r|Biggl/r +Params : Parameters for the inset. \begin_inset Newline newline \end_inset -: TeX code for delimiter. - See Delimiter dialog for delimiters to be used. -\end_layout - -\begin_layout Description -Sample math-bigdelim "Bigl" " -\backslash -Downarrow" "Bigr" " -\backslash -}" +Currently only the filename will be considered. \end_layout - \begin_layout Description -Origin Enrico & Georg, 7 May 2006 +Origin JSpitzm, 27 Apr 2006 \end_layout \begin_layout Subsection* -LFUN_MATH_DISPLAY -\end_layout - -\begin_layout Description -Action Creates a new displayed equation in text mode. - Toggles inlined/display formula in math mode. +LFUN_INSET_END \end_layout - \begin_layout Description -Syntax math-display [] +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 -Params : this argument will be passed to LFUN_MATH_INSERT when creating - new equation from the text mode. +Syntax inset-end \end_layout - \begin_layout Description -Origin Alejandro, 18 Jun 1996 +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_MATH_INSERT -\end_layout - -\begin_layout Description -Action Inserts math objects and symbols. +LFUN_INSET_END_SELECT \end_layout - \begin_layout Description -Notion When is a _single_ math inset with more than one cell (such - as "x_y^z" or " -\backslash -frac{x}{y}"), the content of cell(0) is replaced by the current selection - (only works if the selection is in mathed). - As an example, if "abc" is selected in mathed, "math-insert -\backslash -frac{x}{y}" replaces "abc" with " -\backslash -frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". - If nothing is selected (or the selection is not in mathed), math-insert - works as expected. +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 math-insert +Syntax inset-end-select \end_layout - \begin_layout Description -Params : Symbol or LaTeX code to be inserted. +Origin lasgouttes, 16 Mar 2009 \end_layout \begin_layout Subsection* -LFUN_MATH_SUBSCRIPT +LFUN_INSET_FORALL \end_layout - \begin_layout Description -Action Enters subscript expression in math expression. +Action Apply the given commands on insets of a given name. \end_layout - \begin_layout Description -Syntax math-subscript +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 -Origin vermeer, 12 Dec 2001 -\end_layout +Syntax inset-forall +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_MATH_SUPERSCRIPT +: 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 -Action Enters superscript expression in math expression. -\end_layout +Sample Remove all index insets: +\begin_inset Newline newline +\end_inset -\begin_layout Description -Syntax math-superscript -\end_layout + inset-forall Index char-delete-forward +\begin_inset Newline newline +\end_inset -\begin_layout Description -Origin vermeer, 12 Dec 2001 -\end_layout +Close all Notes (also works for a particular branch, for example): +\begin_inset Newline newline +\end_inset -\begin_layout Subsection* -LFUN_MATH_LIMITS -\end_layout + inset-forall Note inset-toggle close +\begin_inset Newline newline +\end_inset -\begin_layout Description -Action Toggles the position of the limits from above/below to the right - side an vice versa in integral symbol, a limit, a summation, etc. -\end_layout +Transform all yellow notes to comments +\begin_inset Newline newline +\end_inset -\begin_layout Description -Notion Put the cursor before the symbol with the limits and then invoke - math-limits. -\end_layout + inset-forall Note:Note inset-modify note Note Comment +\begin_inset Newline newline +\end_inset -\begin_layout Description -Syntax math-limits [] -\end_layout +Try to put LyX in an infinite loop if there is at least a Note: +\begin_inset Newline newline +\end_inset + inset-forall Note char-backward +\end_layout \begin_layout Description -Params : limits|nolimits +Origin lasgouttes, 27 Nov 2009 \end_layout \begin_layout Subsection* -LFUN_MATH_MACRO +LFUN_INSET_INSERT \end_layout - \begin_layout Description -Action Inserts a math macro definition at the cursor position in the text. +Action Insert new inset (type given by the parameters). \end_layout - \begin_layout Description -Syntax math-macro [] [def] +Syntax inset-insert \end_layout - \begin_layout Description -Params : The name of the macro, e.g. - "mymacro". +Params : : The number of parameters of the macro. - Default is 0. - "def": Has no effect anymore, just for compatibility with former LyX versions. -\end_layout + hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script> +\begin_inset Newline newline +\end_inset -\begin_layout Description -Origin ale, 10 May 1997; sts, 21 Dec 2007 +: depends on the given inset. Use "lyx -dbg action" to explore. \end_layout +\begin_layout Description +Sample inset-insert ref LatexCommand reference "