* \li Action: Insert a tab into a listings inset.
* \li Notion: It also works on a selection.
* \li Syntax: tab-insert
- * \li Origin: vfvanravesteijn, Sep 30 2008
+ * \li Origin: vfr, Sep 30 2008
* \endvar
*/
{ LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
beginning of each line spanned by the selection. This is useful if
you want to indent/unindent multiple lines in one action.
* \li Syntax: tab-delete
- * \li Origin: vfvanravesteijn, Sep 30 2008
+ * \li Origin: vfr, Sep 30 2008
* \endvar
*/
{ LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
* \li Action: Inserts quotes according to the type and quote-language preference.
- * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
+ * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
are distinguished.
* \li Syntax: quote-insert [<TYPE>]
* \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
* \endvar
*/
{ LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
-/*! \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
+/*!
+ * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
* \li Action: Moves the cursor to the logically next beginning of a word.
* \li 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.
if it is not already there, or at the beginning of the
enclosing inset otherwise
* \li Syntax: inset-begin
- * \li Origin: JMarc, 2009/03/16
+ * \li Origin: lasgouttes, 16 Mar 2009
* \endvar
*/
{ LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
enclosing inset otherwise (adding the
traversed text to the selection).
* \li Syntax: inset-begin-select
- * \li Origin: JMarc, 2009/03/16
+ * \li Origin: lasgouttes, 16 Mar 2009
* \endvar
*/
{ LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
if it is not already there, or at the end of the
enclosing inset otherwise
* \li Syntax: inset-end
- * \li Origin: JMarc, 2009/03/16
+ * \li Origin: lasgouttes, 16 Mar 2009
* \endvar
*/
{ LFUN_INSET_END, "inset-end", ReadOnly, Edit },
enclosing inset otherwise (adding the
traversed text to the selection).
* \li Syntax: inset-end-select
- * \li Origin: JMarc, 2009/03/16
+ * \li Origin: lasgouttes, 16 Mar 2009
* \endvar
*/
{ LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
{ 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 },
* \var lyx::FuncCode lyx::LFUN_MATH_MACRO
* \li Action: Inserts a math macro definition at the cursor position in the text.
* \li Syntax: math-macro <NAME> [<NARGS>] [def]
- * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
+ * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
<NARGS>: The number of parameters of the macro. Default is 0.
"def": Has no effect anymore, just for compatibility with former LyX versions.
* \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
* \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
custom space: hspace \n
- "," used by default.
+ "," used by default.\n
Note that ! is equivalent to negthinspace, , = thinspace,
- : = medspace, and ; = thickspace.
+ : = medspace, and ; = thickspace.\n
<LEN>: length for custom spaces (hspace)
* \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
* \endvar
* \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
*/
* \li Notion: Provides an interface to the LaTeX math mode font size commands.
* \li Syntax: math-size <STYLE>
* \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
- * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
+ * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
* \endvar
*/
{ LFUN_MATH_SIZE, "math-size", Noop, Math },
This function only modifies, and does not override, existing settings.
Note that the "leftindent" indent setting is deprecated.
* \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
- * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
- <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
- <ALIGN>: \\align block|left|right|center|default\n
- <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
+ * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
+ <SPACING>: \paragraph_spacing default|single|onehalf|double|other\n
+ <ALIGN>: \align block|left|right|center|default\n
+ <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
* \li Origin: rgh, Aug 15 2007
* \endvar
*/
* \li Syntax: dialog-show <NAME> [<DATA>]
* \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|nomenclature|label|listings|log|mathdelimiter|\n
- mathmatrix|mathspace|note|paragraph|phantom|prefs|print|ref|sendto|space|\n
- spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|\n
- view-source|vspace|wrap|<SPECIAL> \n
+ href|include|index|index_print|info|label|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
<SPECIAL>: latexlog|vclog \n
<DATA>: data, usually settings for the given dialog. Use debug mode for the
details.
* \var lyx::FuncCode lyx::LFUN_CALL
* \li Action: Executes a command defined in a .def file.
* \li Notion: The definitions are by default read from lib/commands/default.def.\n
- A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
+ A .def file allows to define a command with \define "<NAME>" "<LFUN>"
where <NAME> is the name of the new command and <LFUN> is the lfun code
to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
- \\def_file "FileName" allows to include another .def file. \n
+ \def_file "FileName" allows to include another .def file. \n
This is particularly useful in connection with toolbar buttons:
Since the name of the button image for this lfun is
lib/images/commands/<NAME>.png this is the way to assign an image
/*!
* \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
*/
/*!
* \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 Syntax: insert-label-as-reference
+ * \li Syntax: label-insert-as-reference
* \li Origin: vfr, 7 Apr 2009
* \endvar
*/
- { LFUN_LABEL_INSERT_AS_REF, "insert-label-as-reference", Noop, Edit},
+ { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
/*!
* \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
projects / lyx.git / blobdiff