/*!
* \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
*/
* \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
*/
* \li Origin: spitz, 05 Mar 2012
* \endvar
*/
- { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
+ { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_IN_IPA
* \li Action: Only active in IPA inset.
{ LFUN_IN_IPA, "in-ipa", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_IPAMACRO_INSERT
- * \li Action: Inserts special IPA characters into the document.
+ * \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.
+ * tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
* \li Origin: JSpitzm, 22 Aug 2012
* \endvar
*/
/*!
* \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
{ 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_REMOVE, "spelling-remove", ReadOnly, Edit },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SPELLING_CONTINUOUSLY
+ * \li Action: Toggle continuous spell checking.
+ * \li Syntax: spelling-continuously
+ * \li Origin: vfr, 24 March 2013
+ * \endvar
+ */
+ { LFUN_SPELLING_CONTINUOUSLY, "spelling-continuously", 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
*/
* \var lyx::FuncCode lyx::LFUN_PASTE
* \li Action: Pastes material (text or picture) from the active clipboard.
* \li Syntax: paste [<TYPE>|<NUM>]
- * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
+ * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html \n
<NUM>: number of the selection in the internal clipboard stack to be pasted.
* \endvar
*/
* \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
* \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_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
* \endvar
*/
{ LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VC_RENAME
+ * \li Action: Renames the document to another name.
+ * \li Notion: Renaming with revision history is only supported by SVN.
+ For CVS it is simulated by adding the document under a new
+ name and deleting the old one. For RCS it is not supported.
+ Disabled if uncommitted changes exist.
+ * \li Syntax: vc-rename <FILENAME>
+ * \li Params: <FILENAME>: New name of the document.\n
+ * A file dialog is opened if no filename is given.
+ * \li Origin: gb, 05 Feb 2013
+ * \endvar
+ */
+ { LFUN_VC_RENAME, "vc-rename", ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VC_COPY
+ * \li Action: Copies the document to another name.
+ * \li Notion: Copying with revision history is only supported by SVN.
+ For RCS and CVS it is simulated by adding the document
+ under a new name.
+ Disabled if uncommitted changes exist.
+ * \li Syntax: vc-copy <FILENAME>
+ * \li Params: <FILENAME>: New name of the document.\n
+ * A file dialog is opened if no filename is given.
+ * \li Origin: gb, 05 Feb 2013
+ * \endvar
+ */
+ { LFUN_VC_COPY, "vc-copy", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
* \li Action: Checks-in/commits the changes of the registered file to the repository.
* \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
In case that <INSET> is "tabular" various math-environment features
are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
- <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
- toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
- align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
- valign-top|valign-bottom|valign-middle|longtabular-align-left|
- longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
- m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
- set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
- set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
- set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
- unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
- set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
- set-special-column|set-special-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|set-tabular-width \n
+ <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|\n
+ copy-column|move-column-right|move-column-left|move-row-down|move-row-up|\n
+ toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|\n
+ align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|\n
+ valign-top|valign-bottom|valign-middle|longtabular-align-left|\n
+ longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|\n
+ m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|\n
+ set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|\n
+ set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|\n
+ set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|\n
+ unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|\n
+ set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|\n
+ set-special-column|set-special-multicolumn|set-special-multirow|\n
+ set-booktabs|unset-booktabs|set-top-space|set-bottom-space|\n
+ set-interline-space|set-border-lines|tabular-valign-top|\n
+ tabular-valign-middle|tabular-valign-bottom|set-tabular-width
<ARG>: additional argument for some commands, use debug mode to explore its values.
* \li Sample: inset-modify note Note Comment \n
inset-modify changetype Ovalbox
/*!
* \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
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|\n
- graphics|href|include|index|index_print|label|line|
+ 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
matches all note insets, while "Note:Note" only matches LyX
yellow note insets.
* \li Sample: Remove all index insets: \n
- inset-forall Index delete-char-forward \n
+ inset-forall Index char-delete-forward \n
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
/*!
* \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
{ 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
* \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
/*!
* \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_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
{ LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_FORALL
- * \li Action: Applies a command to all visible, hidden, or both types of buffers in the active window.
- * \li Syntax: buffer-forall [<BUFFER-TYPE>] <LFUN-COMMAND>
- * \li Params: <BUFFER-TYPE>: <visible|hidden|both default:> default: visible
- <LFUN-COMMAND>: The command that is to be applied to the buffers.
- * \li Sample: Close all Notes in all visible documents: \n
+ * \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 all documents: \n
- buffer-forall both changes-track \n
- Toggle read-only for all visible documents: \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 each document: \n
- buffer-forall both statistics \n
- Activate the branch named "Solutions" in all visible documents: \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 all visible documents to PDF (pdflatex): \n
+ Export buffers to PDF (pdflatex): \n
buffer-forall buffer-export pdf2 \n
* \li Origin: scottkostyshak, 20 Jul 2012
* \endvar
{ 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
*/
{ 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
};
if (ici == lyx_info_map.end()) {
LYXERR0("action: " << action << " is not known.");
- LASSERT(false, /**/);
+ LASSERT(false, return false);
}
return ici->second.attrib & flag;
projects / lyx.git / blobdiff