/*!
* \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
* \li Action: Inserts an argument (short title) inset.
- * \li Syntax: argument-insert
+ * \li Syntax: argument-insert <argument nr>
+ * \li Params: <argument nr>: see layout declarations
* \li Origin: vermeer, 12 Aug 2002
* \endvar
*/
{ LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
- * \li Action: Inserts a horizontal line.
- * \li Syntax: line-insert
- * \li Origin: Andre, Oct 27 2003
- * \endvar
- */
- { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
* \li Action: Inserts a new page.
package: name of latex package (e.g. listings) \n
textclass: name of textclass (e.g. article) \n
menu: name of lfun used in menu \n
- icon: name of lfun used in toolbar \n
+ icon: icon of lfun used in toolbar \n
buffer: "name"|"path"|"class"|"vcs-tree-revision"|
"vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
* \li Sample: command-sequence info-insert buffer path; info-insert buffer name
a few contained in the Logical Markup module. You can also of
course create some yourself. \n
For dissolving the element see #LFUN_INSET_DISSOLVE.
- * \li Syntax: flex-insert <TYPE:Name>
- * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
- Identifies whether this is a Character Style, a
- Custom Inset or an XML Element, and which dynamical
- sub-menu this flex inset is in on the LyX menu tree.
- If Standard (currently unused): none of these.\n
- Name: This name must be defined either in your layout file
+ * \li Syntax: flex-insert Name
+ * \li Params: Name: This name must be defined either in your layout file
or imported by some module. The definition is
- InsetLayout <TYPE:Name>
- * \li Sample: flex-insert CharStyle:Code
+ InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
+ prefix is optional.
+ * \li Sample: flex-insert Code
* \endvar
*/
{ LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
* \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
* \li Action: Inserts one of horizontal space insets.
* \li Syntax: space-insert <NAME> [<LEN>]
- * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
- negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
- hspace* \n
+ * \li Params: <NAME>: normal, protected, visible, thin, quad, qquad, enspace,
+ enskip, negthinspace, negmedspace, negthickspace, hfill,
+ hfill*, dotfill, hrulefill, hspace, hspace* \n
+ Only in math mode: med and thick.\n
<LEN>: length for custom spaces (hspace, hspace* for protected)
* \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
* \endvar
*/
{ LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
- * \li Action: Inserts table of contents.
- * \li Syntax: toc-insert
- * \li Origin: Lgb, 27 May 97
+ * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
+ * \li Action: Inserts a subscript or superscript inset.
+ * \li Syntax: script-insert <TYPE>
+ * \li Params: <TYPE>: subscript|superscript
+ * \li Origin: Georg, 23 Nov 2010
* \endvar
*/
- { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
+ { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_APPENDIX
* \li Action: Start (or remove) Appendix on the given cursor position.
* \li Notion: It automatically takes the word on the cursor position.
* \li Syntax: index-insert [<TYPE:Name>]
* \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+ With an empty argument, the default index is selected.
* \li Origin: leeming, 3 Aug 2000
* \endvar
*/
* \li Action: Inserts list of Index entries on a new page.
* \li Syntax: index-print [<TYPE:Name>]
* \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
- with an empty argument, the default index is selected.
+ With an empty argument, the default index is selected.
* \li Origin: Lgb, 27 Feb 1997
* \endvar
*/
{ LFUN_INDEX_PRINT, "index-print", Noop, Edit },
-
+/*!
+ * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
+ * \li Action: Inserts an IPA inset.
+ * \li Syntax: ipa-insert
+ * \li Origin: spitz, 05 Mar 2012
+ * \endvar
+ */
+ { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_IN_IPA
+ * \li Action: Only active in IPA inset.
+ * \li 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.
+ * \li Syntax: in-ipa
+ * \li Origin: spitz, 20 May 2012
+ * \endvar
+ */
+ { LFUN_IN_IPA, "in-ipa", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
+ * \li Action: Inserts special IPA macros into the document.
+ * \li Syntax: ipamacro-insert <CHAR>
+ * \li Params: <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising,
+ * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
+ * \li Origin: JSpitzm, 22 Aug 2012
+ * \endvar
+ */
+ { LFUN_IPAMACRO_INSERT, "ipamacro-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
* \li Action: Inserts Nomenclature entry.
/*!
* \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
- * \li Action: Inserts Note on the current cursor postion,
+ * \li Action: Inserts Note on the current cursor position,
move selection inside the inset.
* \li Syntax: note-insert [<TYPE>]
* \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
{ LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
- * \li Action: Moves the cursor to the begining of next Note inset.
+ * \li Action: Moves the cursor to the beginning of next Note inset.
* \li Syntax: note-next
* \endvar
*/
{ LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
- * \li Action: Inserts phantom on the current cursor postion,
+ * \li Action: Inserts phantom on the current cursor position,
move selection inside the inset.
* \li Syntax: phantom-insert [<TYPE>]
* \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
{ LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
- * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
+ * \li Action: Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
* \li Syntax: word-delete-backward
* \endvar
*/
{ LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_FIND
- * \li Action: Search for next occurence of a string.
+ * \li Action: Search for next occurrence of a string.
* \li Syntax: word-find [<DATA>]
* \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
If no parameter is given, search with last find-dialog
* \li Params: <DATA>: data is of the form
"<replace> \n
<search> \n
- <casesensitive> <matchword> <all> <forward>"
+ <casesensitive> <matchword> <all> <forward> <findnext>"
* \li Origin: Andre, Jan 7 2004
* \endvar
*/
{ LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
- * \li Action: Search for next occurence of a pattern.
+ * \li Action: Search for next occurrence of a pattern.
* \li Syntax: word-findadv [<DATA>]
* \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
If no parameter is given, search with last find-dialog
* \endvar
*/
{ LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
+ * \li Action: Remove the word under the cursor from the respective
+ * spell checker dictionary.
+ * \li Syntax: spelling-remove [<STRING>] [<LANG>]
+ * \li Params: <WORD>: word to remove
+ <LANG>: language name (see file languages)
+ * \li Origin: SWitt, 28 July 2010
+ * \endvar
+ */
+ { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
* \li Action: Look up thesaurus entries with respect to the word under the cursor.
/*!
* \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
- * \li Action: Move the cursor to the begining of the (screen) line.
+ * \li Action: Move the cursor to the beginning of the (screen) line.
* \li Syntax: line-begin
* \endvar
*/
{ LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
/*!
* \var lyx::FuncCode lyx::LFUN_COPY
- * \li Action: Copies to the clipboard the last edit.
+ * \li Action: Copies the current selection to the clipboard.
* \li Syntax: copy
* \endvar
*/
* \li Action: Pastes text from the active clipboard.
* \li Syntax: clipboard-paste [<ARG>]
* \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
- * \li Origin: baum, 10 Jul 2006
+ * \li Origin: Georg, 10 Jul 2006
* \endvar
*/
{ LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
- * \li Action: Pastes the currently text selected text.
+ * \li Action: Pastes the currently selected text.
* \li Notion: Primary selection mechanism is linux-only thing.
* \li Syntax: primary-selection-paste [<ARG>]
* \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
{ LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
- * \li Action: Pastes the text in permanent selection.
+ * \li Action: Pastes the internal selection text in permanent selection.
+ * \li Notion: Created in order to have middle mouse button pasting correct (bound to
+ command-alternatives selection-paste ; primary-selection-paste paragraph).
* \li Syntax: selection-paste
+ * \li Origin: lasgouttes, 14 Jan 2009
* \endvar
*/
{ LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
+ * \li Action: Pastes simple unformatted text from the active clipboard.
+ * \li Syntax: clipboard-paste-simple [<ARG>]
+ * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
+ * \endvar
+ */
+ { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_UNDO
* \li Action: Undoes the last edit.
* \li Syntax: undo
* \endvar
*/
- { LFUN_UNDO, "undo", Noop, Edit },
+ { LFUN_UNDO, "undo", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_REDO
* \li Action: Redoes the last thing undone.
* \li Syntax: redo
* \endvar
*/
- { LFUN_REDO, "redo", Noop, Edit },
+ { LFUN_REDO, "redo", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_REPEAT
* \li Action: Repeat the given command.
* \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
* \li Action: Toggle user-defined (=last-time used) text style.
* \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
- automatically trigerred when using Text Style dialog.
+ automatically triggered when using Text Style dialog.
* \li Syntax: textstyle-apply
* \li Origin: leeming, 12 Mar 2003
* \endvar
* \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
* \li Action: Adds database, which will be used for bibtex citations.
* \li Notion: Databases are added to the first BibTeX inset
- (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
+ (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
* \li Syntax: bibtex-database-add <DATABASE-NAME>
* \li Origin: Ale, 30 May 1997
* \endvar
* \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
* \li Action: Adds database, which will be used for bibtex citations.
* \li Notion: Databases are deleted from the first BibTeX inset
- (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
+ (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
* \li Syntax: bibtex-database-del <DATABASE-NAME>
* \li Origin: Ale, 30 May 1997
* \endvar
{ LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
/*!
* \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
- * \li Action: Enters subscript expression in math expression.
+ * \li Action: Enters superscript expression in math expression.
* \li Syntax: math-superscript
* \li Origin: vermeer, 12 Dec 2001
* \endvar
* \li Notion: Selection can be used to determine the input for the external program.
* \li Syntax: math-extern <LANG> [<COMMAND>]
* \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
- where "script" stands fot the external script (normalized
+ where "script" stands for the external script (normalized
expression will be passed)
* \li Origin: Andre, 24 Apr 2001
* \li Sample: math-extern maple simplify
* \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
* \li Action: Changes the text style used in math.
* \li Syntax: math-font-style <STYLE>
- * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
- |textnormal|textrm|textsf|texttt|textbf|textmd|textit
- |textsc|textsl|textup
+ * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
+ |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
* \li Origin: vfr, 9 jan 2009
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
* \li Action: Moves the current paragraph upwards in the document.
+ * \li Notion: Movement through the document will possibly break the paragraph-depth
+ (e.g. itemize structure).
* \li Syntax: paragraph-move-up
* \li Origin: Edwin, 8 Apr 2006
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
- * \li Action: Move the cursor to the next paragraph (or begining of the current one)
+ * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
in upward direction.
* \li Syntax: paragraph-up
* \li Origin: Asger, 1 Oct 1996
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
* \li Action: Move the cursor and select the text to the next paragraph (or
- begining of the current one) in upward direction.
+ beginning of the current one) in upward direction.
* \li Syntax: paragraph-up-select
* \li Origin: Asger, 1 Oct 1996
* \endvar
{ LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
- * \li Action: Move the cursor to the next paragraph (or begining of the current one)
+ * \li Action: Move the cursor to the next paragraph (or beginning of the current one)
in downward direction.
* \li Syntax: paragraph-down
* \li Origin: Asger, 1 Oct 1996
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
* \li Action: Move the cursor and select the text to the next paragraph (or
- begining of the current one) in downward direction.
+ beginning of the current one) in downward direction.
* \li Syntax: paragraph-down-select
* \li Origin: Asger, 1 Oct 1996
* \endvar
*/
{ LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
/*!
- * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
+ * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_BREAK
* \li Action: Breaks the current paragraph at the current location.
* \li Notion: Removes the selection.
- * \li Syntax: break-paragraph [<LAYOUT>]
+ * \li Syntax: paragraph-break [<LAYOUT>]
* \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
to default layout) when the cursor is at the end of
the line.
* \endvar
*/
- { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
+ { LFUN_PARAGRAPH_BREAK, "paragraph-break", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
* \li Action: Change paragraph settings.
/*!
* \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
* \li Action: Updates the values inside the paragraph dialog from the paragraph.
- * \li Notion: This is internal LFUN, not to be used by users. Called internally
+ * \li Notion: This is an internal LFUN, not to be used by users. Called internally
by #LFUN_DIALOG_UPDATE.
* \li Origin: leeming, 13 Mar 2003
* \endvar
* \li Origin: Jug, 22 May 2000
* \endvar
*/
- { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
+ { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
* \li Action: Moves the cursor to the next cell inside the table.
* \li Syntax: cell-forward
* \endvar
*/
- { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
+ { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
* \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
/*!
* \var lyx::FuncCode lyx::LFUN_VC_REGISTER
- * \li Action: Register the document as an file inside version control system (RCS, CVS).
+ * \li Action: Register the document as an file inside version control system.
* \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
of cvs/svn/rcs entries in the document's directory. \n
See LyX Additional Features Manual (Version Control Chapter) for additional
{ LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
- * \li Action: Checks-out the document for edit (and locks it for RCS).
- * \li Notion: This is implemented only for RCS and SVN, not CVS.
+ * \li Action: Checks-out the document for edit (and locks it in some cases).
* \li Syntax: vc-check-out
* \li Origin: Lgb, 1 Jul 1997
* \endvar
* \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
* \li Action: Update the local archive directory in which resides
the current document with the remote repository.
- * \li Notion: This is currently implemented only for SVN.
* \li Syntax: vc-repo-update
* \li Origin: sanda, 16 Oct 2009
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_VC_COMPARE
* \li Action: Compares two revisions of the same file under version control.
- * \li Notion: This is currently implemented only for SVN and RCS.
- * \li Syntax: vc-compare <REV1> [<REV2>]
+ * \li Syntax: vc-compare [<REV1>] [<REV2>]
* \li Params: Revision number either points directly to commit in history
- or if negative number -x it points to last commit - x.\n
+ or if negative number -x it points to (last commit - x).\n
In RCS we subtract only in the last number of revision specification.
Special case "0" is reserved for the last committed revision.\n
<REV1>: Older file.\n
- <REV2>: Newer file. Used only if REV1 > 0.
+ <REV2>: Newer file. Used only if REV1 > 0.\n
+ If no parameter is given, interactive dialog will be shown.
* \li Sample: Compare current document against last commit\n
- vc-compare 0
- * \li Sample: Compare current document against current revision - 5 commits\n
- vc-compare -5
- * \li Sample: Compare revisions 120 and 155\n
- vc-compare 120 155
+ vc-compare 0\n
+ Compare current document against current revision - 5 commits\n
+ vc-compare -5\n
+ Compare revisions 120 and 155\n
+ vc-compare 120 155
* \li Origin: sanda, 12 Feb 2010
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
* \li Action: Rejects tracked change inside the selection.
- * \li Syntax: change-accept
+ * \li Syntax: change-reject
* \li Origin: Levon, 16 Oct 2002
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_INSET_INSERT
* \li Action: Insert new inset (type given by the parameters).
* \li Syntax: inset-insert <INSET> <ARGS>
- * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular
- hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
+ * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
+ hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
<ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
* \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
where <label name> is the name of the referenced label and
pageref -- <page> \n
vpageref -- on <page> \n
vref -- <reference> on <page> \n
- prettyref -- Formatted reference
+ formatted -- Formatted reference
* \endvar
*/
{ LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
set-special-column|set-special-multicolumn|set-special-multirow|
set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
set-interline-space|set-border-lines|tabular-valign-top|
- tabular-valign-middle|tabular-valign-bottom \n
+ tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
<ARG>: additional argument for some commands, use debug mode to explore its values.
- * \li Sample: inset-modify note Note Comment
- * \li Sample: inset-modify changetype Ovalbox
+ * \li Sample: inset-modify note Note Comment \n
+ inset-modify changetype Ovalbox
* \endvar
*/
{ LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
* \li Action: Updates the values inside the dialog from the inset.
- * \li Notion: This is internal LFUN, not to be used by users. Called internally
+ * \li Notion: This is an internal LFUN, not to be used by users. Called internally
by #LFUN_DIALOG_UPDATE
* \li Params: <DIALOG-NAME>
* \li Origin: leeming, 25 Feb 2003
* \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
* \li Action: Open the inset's properties dialog.
* \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
- float, graphics, href, include, index, index_print, label, listings,
- note, phantom, ref, space, tabular, vspace, wrap insets.
+ float, graphics, href, include, index, index_print, label, line,
+ listings, note, phantom, ref, space, tabular, vspace, wrap insets.
* \li Syntax: inset-settings <INSET>
- * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
- graphics|href|include|index|index_print|label|listings|
- note|phantom|ref|space|tabular|vspace|wrap>.
+ * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
+ graphics|href|include|index|index_print|label|line|\n
+ listings|note|phantom|ref|space|tabular|vspace|wrap>.
* \endvar
*/
{ LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
- * \li Action: Toggles the collapsable inset at cursor position,
+ * \li Action: Toggles the collapsible inset at cursor position,
or the inset we are currently in.
* \li Syntax: inset-toggle [<ARG>]
* \li Params: <ARG>: <open|close|toggle|assign>. \n
- open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
+ open/close/toggle are for collapsible insets. toggle is used when no argument is given.\n
assign synchronize the branch-inset with activation status of the branch.
Used for global toggling when changed activation.
* \li Origin: lasgouttes, 19 Jul 2001
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 10000.
+ 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.
Close all Notes (also works for a particular branch, for example): \n
inset-forall Note inset-toggle close \n
Transform all yellow notes to comments \n
- inset-forall Note:Note inset-modify note Note Comment \n
+ inset-forall Note:Note inset-modify note Note Comment \n
Try to put LyX in an infinite loop if there is at least a Note: \n
inset-forall Note char-backward
* \li Origin: lasgouttes, 27 Nov 2009
/*!
* \var lyx::FuncCode lyx::LFUN_LANGUAGE
* \li Action: Set language from the current cursor position.
- * \li Syntax: language <LANG>
+ * \li Syntax: language <LANG> [set]
* \li Params: <LANG>: Requested language. Look in lib/languages for
- the list.
+ the list. "language reset" or "language" (without param)
+ reset to the document language.
+ set: If used, the language will be set to the specified
+ language. Otherwise, the language will be toggled (i.e., if
+ the current language is LANG, switch to the document language
+ or the default language, if LANG is the document language).
* \li Origin: Dekel, 2 Mar 2000
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
* \li Action: Moves the cursor to the numbered bookmark, opening the file
- if necessary. Note that bookmarsk are saved per-session, not
+ if necessary. Note that bookmarks are saved per-session, not
per file.
* \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
1. to the paragraph you are currently editing \n
* \li Action: Toggles visibility of a given toolbar between on/off/auto.
* \li Notion: Skipping "auto" when allowauto is false.
* \li Syntax: toolbar-toggle <NAME> [allowauto]
- * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
+ * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
minibuffer|review|view/update|math_panels|vcs|
view-others|update-others
* \li Origin: Edwin, 21 May 2007
{ LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
/*!
- * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
+ * \var lyx::FuncCode lyx::LFUN_VIEW_SPLIT
* \li Action: Creates another split view of current buffer.
- * \li Notion: All split views act in the same way indpendently.
- * \li Syntax: split-view <vertical|horizontal>
+ * \li Notion: All split views act in the same way independently.
+ * \li Syntax: view-split <vertical|horizontal>
* \li Params: horizontal : The work areas are laid out side by side.\n
vertical : The work areas laid out vertically.
* \li Origin: Abdel, 20 Feb 2008
* \endvar
*/
- { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
+ { LFUN_VIEW_SPLIT, "view-split", ReadOnly, Buffer },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VIEW_CLOSE
+ * \li Action: Close the current document work area.
+ * \li Notion: Close the current work area. If no other work areas are showing the buffer,
+ then close the associated buffer as well.
+ * \li Syntax: view-close
+ * \li Origin: Tommaso, 15 Sep 2012
+ * \endvar
+ */
+ { LFUN_VIEW_CLOSE, "view-close", ReadOnly, Buffer },
/*!
- * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
+ * \var lyx::FuncCode lyx::LFUN_TAB_GROUP_CLOSE
* \li Action: Close the current tab group.
- * \li Notion: This only closes the work areas, not the buffer themselves.
+ * \li Notion: This only closes the work areas, not the buffers themselves.
The still opened buffers can be visualized in another tab group.
- * \li Syntax: close-tab-group
+ * \li Syntax: tab-group-close
* \li Origin: Abdel, 21 Feb 2008
* \endvar
*/
- { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
+ { LFUN_TAB_GROUP_CLOSE, "tab-group-close", ReadOnly, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
- * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
+ * \li Action: Shows hidden dialog or creates new one for a given function/inset settings etc.
* \li Syntax: dialog-show <NAME> [<DATA>]
* \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
- graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
+ graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
* \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
* \li Action: This function is called when mouse button is pressed (inside workarea).
Action depends on the context.
- * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Notion: This is an internal LFUN, not to be used by users.
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
* \li Action: This function is called when double click on mouse button is
pressed (inside workarea). Action depends on the context.
- * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Notion: This is an internal LFUN, not to be used by users.
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
* \li Action: This function is called when triple click on mouse button is
pressed (inside workarea). Action depends on the context.
- * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Notion: This is an internal LFUN, not to be used by users.
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
* \li Action: This function is called when mouse cursor is moving over the text.
Action depends on the context.
- * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Notion: This is an internal LFUN, not to be used by users.
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
* \li Action: This function is called when mouse button is released (inside workarea).
Action depends on the context.
- * \li Notion: This is internal LFUN, not to be used by users.
+ * \li Notion: This is an internal LFUN, not to be used by users.
* \li Origin: Andre, 9 Aug 2002
* \endvar
*/
* \li Action: Turn on the primary keyboard map.
* \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
keyboard support. They can be still used to maintain uniform keyboard
- layout across the various plaforms.\n
+ layout across the various platforms.\n
The language is to be set in the Preferences dialog.
* \li Syntax: keymap-primary
* \endvar
{ LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
- * \li Action: Sets the cursor position based on the row number of generated TeX file.
+ * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
* \li Notion: This can be useful for DVI inverse-search or detection of the problematic
line from LaTeX compilation. Note that before this function can be used
export to LaTeX output must occur (in order to map the row numbers).
* \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
- * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
+ * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
In case this LFUN does not work make sure you are giving correct
path to the file.\n
If the file is located inside LyX temporary directory it will be
mapped back into the appropriate opened buffer (e.g. for the case
- of generated .tex file).
- .ext: extensions will be automatically replaced by .lyx.
+ of generated .tex file).\n
+ .ext: extensions will be automatically replaced by .lyx.\n
<ROW_NUMBER> The row number of the LaTeX file to which to go.
+ * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
+ server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
* \li Origin: Edmar, 23 Dec 1998
* \endvar
*/
{ LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
/*!
* \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
- * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
+ * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
number in LyX window.
* \li Notion: The external program used for forward search call can be specified in
- \forward_search_dvi and \forward_search_pdf RC settings.
- By default, the value for pdf is empty, while for dvi it is\n
- "xdvi -sourceposition $$n:$$t $$o"\n
- The values replaced in the call: $$n for row number, $$t for
- exported temporary .tex file, $$o exported output file, either
- dvi or pdf, depending on which one exists in the temp dir
- (preferred is dvi).
+ LyX Output preferences. See Additional manual for details of these
+ settings.
* \li Syntax: forward-search
* \li Origin: sanda, 14 Apr 2010
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
* \li Action: Sets the cursor position based on the editing area coordinates
- (similar as clicking on that point with left mouse button).
+ (similar to clicking on that point with left mouse button).
* \li Syntax: server-set-xy <X> <Y>
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
* \li Action: Generates the code (literate programming).
* \li Notion: Latex file with extension \literate_extension is generated.
- Then LyX invokes \build_command (with a default of``make'') to generate the code and
+ Then LyX invokes \build_command (with a default of ``make'') to generate the code and
\build_error_filter to process the compilation error messages. \n
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:\n
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
* \li Action: Exports the current buffer (document) to the given format.
- * \li Syntax: buffer-export <FORMAT>
+ * \li Syntax: buffer-export <FORMAT> [<DEST>]
* \li Params: <FORMAT> is either "custom" or one of the formats which you
can find in Tools->Preferences->File formats->Format.
Usual format you will enter is "pdf2" (pdflatex),
want to start from and for the command that you want to
apply to this format. Internally the control is then passed
to #LFUN_BUFFER_EXPORT_CUSTOM.
+ <DEST> If present, this argument provides the export destination
+ filename. Its containing folder will also be the destination
+ folder, where all the needed external files will be copied.
* \li Origin: Lgb, 29 Jul 1997
* \endvar
*/
* \endvar
*/
{ LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
+ * \li Action: Pops up a dialog for exporting the current buffer.
+ * \li Syntax: buffer-export-as
+ * \li Origin: tommaso, 6 Oct 2011
+ * \endvar
+ */
+ { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
* \li Action: Prints the current document.
* \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
* \li Action: Import a given file as a lyx document.
* \li Notion: File can be imported iff lyx file format is (transitively) reachable via
- defined convertors in preferences. Look into File->Import menu to get
+ defined converters in preferences. Look in the File->Import menu to get
an idea of the currently active import formats.
* \li Syntax: buffer-import <FORMAT> [<FILE>]
* \li Origin: Asger, 24 Jul 1998
{ LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
- * \li Action: Creates a new buffer (that is, document).
+ * \li Action: Creates a new buffer (that is, document) and switches to it.
* \li Notion: Implicit path can be set in Preferences dialog.
* \li Syntax: buffer-new [<FILE>]
* \li Params: <FILE>: filename of created file with absolute path.
{ LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
- * \li Action: Display/switch to the given buffer.
+ * \li Action: Display and switch to the given buffer.
* \li Syntax: buffer-switch <BUFFER>
* \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
document which is to be shown.
* \li Action: Exports the current document and put the result into the
temporary directory.
* \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
- the output will be rewriten - updated. This is useful in case your viewer
+ the output will be rewritten - updated. This is useful in case your viewer
is able to detect such changes (e.g. ghostview for postscript).
* \li Syntax: buffer-update [<FORMAT>]
* \li Params: <FORMAT>: The format to display, where this is one of the
* \endvar
*/
{ LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
-/*!
- * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ENCRYPTED
- * \li Action: Saves the current buffer encyrpted.
- * \li Notion: Saves the current buffer encyrpted to disk, asks for a new filename
- * \li Syntax: buffer-write-encyrypted
- * \endvar
- */
- { LFUN_BUFFER_WRITE_ENCRYPTED, "buffer-write-encrypted", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
* \li Action: Rename and save current buffer.
* \endvar
*/
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
+ * \li Action: Applies a command to all non-hidden buffers.
+ * \li Notion: a buffer is `hidden' if it is internally open in LyX, but not
+ visible in any window.
+ * \li Syntax: buffer-forall <LFUN-COMMAND>
+ * \li Params: <LFUN-COMMAND>: The command to be applied to the buffers.
+ * \li Sample: Close all Notes in buffers: \n
+ buffer-forall inset-forall Note inset-toggle close \n
+ Toggle change tracking on buffers: \n
+ buffer-forall changes-track \n
+ Toggle read-only for buffers: \n
+ buffer-forall buffer-toggle-read-only \n
+ Show statistics for individual buffers: \n
+ buffer-forall statistics \n
+ Activate the branch named "Solutions" in buffers: \n
+ buffer-forall branch-activate Solutions \n
+ Export buffers to PDF (pdflatex): \n
+ buffer-forall buffer-export pdf2 \n
+ * \li Origin: scottkostyshak, 20 Jul 2012
+ * \endvar
+ */
+ { LFUN_BUFFER_FORALL, "buffer-forall", ReadOnly | Argument, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
* \li Action: Save all changed documents.
{ LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
/*!
* \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
- * \li Action: Determine whether keep cursor inside the editing window regardless
- the scrollbar movement.
+ * \li Action: Determine whether to keep cursor inside the editing window regardless
+ of the scrollbar movement.
* \li Syntax: toggle-cursor-follows-scrollbar
* \li Origin: ARRae, 2 Dec 1997
* \endvar
* \li Origin: spitz, 7 Jul 2009
* \endvar
*/
- { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
+ { LFUN_BRANCH_ADD, "branch-add", AtPoint, Buffer },
/*!
* \endvar
*/
{ LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_ACTIVATE
+ * \li Action: Activate the branch in the master buffer.
+ * \li Syntax: branch-master-activate <BRANCH>
+ * \li Params: <BRANCH>: The branch to activate
+ * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
+ could be used to export a pdf with the answers branch included
+ without one's having to open LyX and activate the branch manually.
+ * \li Origin: spitz, 30 Sep 2012
+ * \endvar
+ */
+ { LFUN_BRANCH_MASTER_ACTIVATE, "branch-master-activate", AtPoint, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_MASTER_DEACTIVATE
+ * \li Action: De-activate the branch in the master buffer.
+ * \li Syntax: branch-master-deactivate <BRANCH>
+ * \li Params: <BRANCH>: The branch to deactivate
+ * \li Origin: spitz, 30 Sep 2012
+ * \endvar
+ */
+ { LFUN_BRANCH_MASTER_DEACTIVATE, "branch-master-deactivate", AtPoint, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
/*!
* \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
- * \li Action: Inserts the label as a cross-reference at the position of the cursor.
+ * \li Action: Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
* \li Syntax: label-insert-as-reference
* \li Origin: vfr, 7 Apr 2009
* \endvar
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
- * \li Action: Copies the inset to the clipboard as a certain type
- * \li Syntax: inset-copy-as [<TYPE>]
- * \li Params: <TYPE>: The type as which the inset is copied. This
- can vary from inset to inset.
- * \li Sample: InsetInfo is copied as text
+ * \li Action: Copies the inset to the clipboard as a certain type.
+ * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
+ * \li Syntax: inset-copy-as
* \li Origin: vfr, 18 Apr 2010
* \endvar
*/
{ LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_ENVIRONMENT_SPLIT
+ * \li Action: Splits the current environment with a Separator.
+ * \li Syntax: environment-split
+ * \li Origin: spitz, 23 Dec 2012
+ * \endvar
+ */
+ { LFUN_ENVIRONMENT_SPLIT, "environment-split", Noop, Layout },
+
{ LFUN_NOACTION, "", Noop, Hidden }
#ifndef DOXYGEN_SHOULD_SKIP_THIS
};
projects / lyx.git / blobdiff