* \li Action: Creates a new buffer (that is, document) from a template.
* \li Notion: Path for new files and templates can be set in Preferences dialog.
Template will be asked for via Open-dialog.
- * \li Syntax: buffer-new-template [<FILE>]
- * \li Params: <FILE>: filename of created file with absolute path.
+ * \li Syntax: buffer-new-template [<FILE>] [<TEMPLATE FILE>]
+ * \li Params: <FILE>: filename of created file with absolute path. If empty
+ * or "newfile", a file with appropriate name is generated.
+ * <TEMPLATE FILE>: filename of template with absolute path. If empty,
+ * a dialog is opened to select the new file.
* \endvar
*/
{ LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
*/
{ LFUN_CUT, "cut", Noop, Edit },
-/*!
- * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
- * \li Action: Inserts the current date.
- * \li Syntax: date-insert [<ARG>]
- * \li Params: <ARG>: Format of date. The default value (%x) can be set
- in Preferences->Output->General->Date format. For
- possible formats see the manual page of the
- strftime function.
- * \li Origin: jdblair, 31 Jan 2000
- * \endvar
- */
- { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
-
/*!
* \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
* \li Action: Set debug output level.
* \li Params: outer: If this is given, LyX will split the outermost environment in
the current nesting hierarchy.\n
previous: If this is given, LyX will split the environment in the previous
- paragraph (is there is one).\n
+ paragraph (if there is one).\n
before: If this is given, the new environment will be appended rather than
prepended.
* \li Origin: spitz, 23 Dec 2012
the work area.\n
2. select the text and run info-insert lfun.
* \li Syntax: info-insert <TYPE> <ARG>
- * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \n
+ * \li Params: <TYPE>: date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc|
+ * lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \n
<ARG>: argument for a given type. Look into InsetInfo.h for detailed
description. \n
+ date: current date (formatted and localized)\n
+ moddate: date of last modification (saving) (formatted and localized)\n
+ fixdate: a static date (formatted and localized)\n
+ time: current time (formatted and localized)\n
+ modtime: time of last modification (saving) (formatted and localized)\n
+ fixtime: a static time (formatted and localized)\n
shortcut[s]: name of lfun (e.g math-insert \alpha) \n
lyxrc: name of rc_entry (e.g. bind_file) \n
lyxinfo: "version" - used version of LyX \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
+ l7n: localizable string.\n
icon: icon of lfun used in toolbar or direct icon name\n
- buffer: "name"|"path"|"class"|"vcs-tree-revision"|
- "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
+ buffer: "name"|"name-noext"|"path"|"class"
+ vcs: "tree-revision"|"revision"|"author"|"date"|"time"
* \li Sample: command-sequence info-insert buffer path; info-insert buffer name
* \li Origin: bpeng, 7 Oct 2007
* \endvar
* \var lyx::FuncCode lyx::LFUN_INSET_EDIT
* \li Action: Edit the inset at cursor with an external application,
if one is attributed.
+ If the inset is file based, the referenced file is edited.
+ Otherwise, the inset contents is written to a temporary file,
+ the inset is locked, and the temporary file is edited.
+ In this case, #LFUN_INSET_END_EDIT must be called to overtake
+ the changes and unlock the inset after editing is finished.
* \li Syntax: inset-edit [<INSET_PARAMS>]
* \li Params: <INSET_PARAMS>: Parameters for the inset. \n
Currently only the filename will be considered.
{ LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
+ /*!
+ * \var lyx::FuncCode lyx::LFUN_INSET_END_EDIT
+ * \li Action: End editing the inset at cursor with an external application.
+ * This replaces the inset contents with the contents of the
+ * temporary file, deletes the file and unlocks the inset.
+ * \li Syntax: inset-end-edit
+ * \li Origin: gb, 11 Oct 2015
+ * \endvar
+ */
+ { LFUN_INSET_END_EDIT, "inset-end-edit", ReadOnly | AtPoint, Edit },
+
/*!
* \var lyx::FuncCode lyx::LFUN_INSET_END
* \li Action: Move the cursor to the end of the current inset if it
* \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
* \li Action: Select all contents of an inset.
* \li Notion: There are 3 successive levels: select current cell,
- * select all cells of inset, select the inset from outside
- * (in the enclosing inset).
+ * select all cells of inset, select the inset from outside
+ * (in the enclosing inset).
* \li Syntax: inset-select-all
* \li Origin: vfr, 22 Aug 2009; lasgouttes 1 Nov 2014
* \endvar
/*!
- * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
+ * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REFERENCE
* \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
* \li Syntax: copy-label-as-reference <LABEL>
* \li Params: <LABEL>: The label to copy (for multi-line math)
*/
{ LFUN_LAYOUT, "layout", Noop, Layout },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_LAYOUT_TOGGLE
+ * \li Action: Toggles the layout (that is, environment) for the current paragraph.
+ * \li Notion: Contrary to `layout', this function resets the current
+ * (or selection) layout to the standard layout it already has the
+ * correct layout. Useful for toolbar icons.
+ * \li Syntax: layout-toggle <LAYOUT> [ignorenests]
+ * \li Params: <LAYOUT>: the layout to toggle\n
+ ignorenests: If specified, nesting advices will be ignored.
+ * \li Origin: lasgouttes, 14 May 2018
+ * \endvar
+ */
+ { LFUN_LAYOUT_TOGGLE, "layout-toggle", Noop, Layout },
+
/*!
* \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
* \li Action: Clears the module list.
{ LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_EXPORT
+ * \li Action: Exports the master buffer (document) to the given format.
+ * \li Syntax: master-buffer-export [<FORMAT>] [<DEST>]
+ * \li Params: <FORMAT> is one of the formats which you can find in
+ Tools->Preferences->File formats->Format.
+ Usual format you will enter is "pdf2" (pdflatex),
+ "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
+ Note that "custom" is not allowed in this case.\n
+ If absent or "default", then the default output format of the
+ document is used.\n
+ <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: rkh, 18 April 2018
+ * \endvar
+ */
+ { LFUN_MASTER_BUFFER_EXPORT, "master-buffer-export", ReadOnly, Buffer },
+
/*!
* \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
* \li Action: Update (export) the document built from the master buffer,
*/
{ LFUN_REPEAT, "repeat", NoBuffer, Edit },
+/*!
+ * \var lyx::FuncCode lyx::LFUN_SEARCH_IGNORE
+ * \li Action: Enables/disables searching for features in findadv
+ * \li Syntax: search-ignore <type> <value>
+ * \li Params: <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike
+ * \li Params: <value>: true|false
+ * \endvar
+ */
+ { LFUN_SEARCH_IGNORE, "search-ignore", ReadOnly|NoBuffer|NoUpdate, System },
+
/*!
* \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
* \li Action: Moves the cursor one page in downward direction.
set-special-column|set-special-multicolumn|set-special-multirow|\n
toggle-booktabs|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\n
+ tabular-valign-middle|tabular-valign-bottom|set-tabular-width|\n
+ toggle-varwidth-column
Various math-environment features are handled as well, e.g. add-vline-left/right for\n
the Grid/Array environment.\n
<ARG>: additional argument for some commands, use debug mode to explore its values.
/*!
* \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
+ * \li Action: Apply last used text properties.
+ * \li Syntax: textstyle-apply [<NUM>]
+ * \li Params: <NUM>: number of the selection in the internal freefonts stack to be applied.
+ * \li Notion: These properties are stored via #LFUN_TEXTSTYLE_UPDATE, which is
automatically triggered when using Text Style dialog.
* \li Syntax: textstyle-apply
* \li Origin: leeming, 12 Mar 2003
projects / lyx.git / blobdiff