the work area.\n
2. select the text and run info-insert lfun.
* \li Syntax: info-insert <TYPE> <ARG>
- * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
+ * \li Params: <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer \n
<ARG>: argument for a given type. Look into InsetInfo.h for detailed
- description.
+ description. \n
+ shortcut[s]: name of lfun (e.g math-insert \alpha) \n
+ lyxrc: name of rc_entry (e.g. bind_file) \n
+ 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
+ buffer: "name"|"path"|"class"
* \li Sample: command-sequence info-insert buffer path; info-insert buffer name
* \li Origin: bpeng, 7 Oct 2007
* \endvar
* \li Action: Replace a string in the document.
* \li Syntax: word-replace [<DATA>]
* \li Params: <DATA>: data is of the form
- "<search> \n
- <replace> \n
+ "<replace> \n
+ <search> \n
<casesensitive> <matchword> <all> <forward>"
* \li Origin: Andre, Jan 7 2004
* \endvar
{ LFUN_CUT, "cut", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_PASTE
- * \li Action: Pastes material from the active clipboard.
- * \li Syntax: paste [<TYPE>]
- * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf
+ * \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
+ <NUM>: number of the selection in the internal clipboard stack to be pasted.
* \endvar
*/
{ LFUN_PASTE, "paste", Noop, Edit },
* \li Action: Inserts math objects and symbols.
* \li Syntax: math-insert <ARG>
* \li Params: <ARG>: Symbol or LaTeX code to be inserted.
+ * \li Notion: When <ARG> is a _single_ math inset with more than one cell
+ (such as "x_y^z" or "\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 \frac{x}{y}" replaces "abc" with "\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.
* \endvar
*/
{ LFUN_MATH_INSERT, "math-insert", Noop, Math },
* \li Action: In text mode enters math mode (i.e. puts math insets on the current
cursor position), in math mode enters text mode inside math expression.
* \li Notion: If there is some selected text, it puts the text inside created math box.
- * \li Syntax: math-mode [<ARG>]
- * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
+ * \li Syntax: math-mode [on|<ARG>]
+ * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
+ "on": allow only entering of math mode from text mode.
* \li Origin: Alejandro, 4 Jun 1996
* \endvar
*/
* \endvar
*/
{ LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
+
+/*!
+ * \var lyx::FuncCode lyx::LFUN_OUTLINE_DRAGMOVE
+ * \li Action: Moves the document section associated with the specified
+ heading to a specified location. Both the heading and the
+ target paragraph are specified by the paragraph ID numbers.
+ * \li Notion: The heading is a paragraph with style Part/Chapter/Section/
+ etc. Id number of the paragraph is not the sequential number
+ seen on the screen, but an internal number that is unique
+ for all opened buffers (documents).
+ * \li Syntax: outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
+ * \li Params: <PAR_ID_SECTION>: paragraph id of the section heading which
+ is to be moved. \n
+ <PAR_ID_DROP_POSITION>: the paragraph id where the section
+ will be moved to.
+ * \li Origin: Rob Oakes, 22 June 2009
+ * \endvar
+ */
+ { LFUN_OUTLINE_DRAGMOVE, "outline-dragmove", Noop, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_EDIT
* \li Action: Edit the inset at cursor with an external application,
* \li Origin: JSpitzm, 27 Apr 2006
* \endvar
*/
+
{ LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
/*!
* \endvar
*/
{ LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
+ * \li Action: Toggles the locking property of the edited file.
+ * \li Notion: This is currently implemented only for SVN.
+ * \li Syntax: vc-locking-toggle
+ * \li Origin: sanda, 25 Jun 2009
+ * \endvar
+ */
+ { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
/*!
* \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
* \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|\n
href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
- mathmatrix|mathspace|nomenclature|note|paragraph|phantom|prefs|print|ref|\n
- sendto|space|spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|\n
- toc|view-source|vspace|wrap|<SPECIAL> \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
<SPECIAL>: latexlog|vclog \n
<DATA>: data, usually settings for the given dialog. Use debug mode for the
details.
/*!
* \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
- * \li Action: Try to cancel completion, either the popup or the inline completion
+ * \li Action: Try to cancel completion, either the popup or the inline completion.
* \li Syntax: completion-cancel
* \li Origin: sts, Sep 07 2008
* \endvar
{ LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
+ * \li Action: Add a branch to the buffer's BranchList.
+ * \li Syntax: branch-add <BRANCH>
+ * \li Params: <BRANCH>: Name of the branch to add
+ * \li Origin: spitz, 7 Jul 2009
+ * \endvar
+ */
+ { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
+
+
/*!
* \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
- * \li Action: Activate the branch
+ * \li Action: Activate the branch.
* \li Syntax: branch-activate <BRANCH>
* \li Params: <BRANCH>: The branch to activate
* \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
{ LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
/*!
* \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
- * \li Action: De-activate the branch
+ * \li Action: De-activate the branch.
* \li Syntax: branch-deactivate <BRANCH>
* \li Params: <BRANCH>: The branch to deactivate
* \li Origin: rgh, 27 May 2008
*/
{ LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
+ * \li Action: Rename all branches of a given name in a document.
+ * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
+ * \li Params: <OLDNAME>: Current name of the branch to be renamed
+ * <NEWNAME>: New name of the branch
+ * \li Origin: spitz, 9 Jul 2009
+ * \endvar
+ */
+ { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
+ * \li Action: Create new branch and directly put the branch inset into
+ the document.
+ * \li Syntax: branch-add-insert [<NAME>]
+ * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
+ * \li Origin: sanda, 10 Jul 2009
+ * \endvar
+ */
+ { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
+
+
/*!
* \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
* \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
- * \li Syntax: copy-label-as-reference
+ * \li Syntax: copy-label-as-reference <LABEL>
+ * \li Params: <LABEL>: The label to copy (for multi-line math)
* \li Origin: sts, 16 Nov 2008
* \endvar
*/
projects / lyx.git / blobdiff