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
* \endvar
*/
{ LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
+/*!
+ * \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_SCRIPT_INSERT, "script-insert", Noop, Edit },
/*!
* \var lyx::FuncCode lyx::LFUN_APPENDIX
* \li Action: Start (or remove) Appendix on the given cursor position.
* \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
*/
* \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.
{ 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
* \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
*/
* \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 Params: Revision number either points directly to commit in history
or if negative number -x it points to (last commit - x).\n
<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|line|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 },
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|
+ * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
graphics|href|include|index|index_print|label|line|
listings|note|phantom|ref|space|tabular|vspace|wrap>.
* \endvar
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
* \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_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_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_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
*/
projects / lyx.git / blobdiff