* \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
* \li Action: Inserts Index entry.
* \li Notion: It automatically takes the word on the cursor position.
- * \li Syntax: index-insert
+ * \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.
* \li Origin: leeming, 3 Aug 2000
* \endvar
*/
/*!
* \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
* \li Action: Inserts list of Index entries on a new page.
- * \li Syntax: index-print
+ * \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.
* \li Origin: Lgb, 27 Feb 1997
* \endvar
*/
* \var lyx::FuncCode lyx::LFUN_PASTE
* \li Action: Pastes material from the active clipboard.
* \li Syntax: paste [<TYPE>]
- * \li Params: <TYPE>: pdf|png|jpeg|linkback
+ * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf
* \endvar
*/
{ LFUN_PASTE, "paste", Noop, Edit },
* \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
* \li Action: Open the inset's properties dialog.
* \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
- * float, graphics, href, include, label, listings, note, phantom,
- * ref, space, tabular, vspace, wrap insets.
+ * float, graphics, href, include, index, index_print, label, 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|
- * graphics|href|include|label|listings|note|phantom|ref|
- * space|tabular|vspace|wrap>.
+ * graphics|href|include|index|index_print|label|listings|
+ * note|phantom|ref|space|tabular|vspace|wrap>.
* \endvar
*/
{ LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
/*!
* \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 Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
+ * \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 expaned 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.
* \li Origin: Edmar, 23 Dec 1998
* \endvar
*/