\begin_body
\begin_layout Section*
-LFUNs documentation automatically generated 2010-02-28
+LFUNs documentation automatically generated 2011-03-04
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Subsection*
-LFUN_OPTIONAL_INSERT
+LFUN_ARGUMENT_INSERT
\end_layout
\begin_layout Description
-Action Inserts an optional-argument (short title) inset.
+Action Inserts an argument (short title) inset.
\end_layout
\begin_layout Description
-Syntax optional-insert
+Syntax argument-insert
\end_layout
\begin_layout Description
Origin vermeer, 12 Aug 2002
\end_layout
-\begin_layout Subsection*
-LFUN_LINE_INSERT
-\end_layout
-\begin_layout Description
-Action Inserts a horizontal line.
-\end_layout
-\begin_layout Description
-Syntax line-insert
-\end_layout
-\begin_layout Description
-Origin Andre, Oct 27 2003
-\end_layout
-
\begin_layout Subsection*
LFUN_NEWPAGE_INSERT
\end_layout
Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
\end_layout
+\begin_layout Subsection*
+LFUN_PREVIEW_INSERT
+\end_layout
+\begin_layout Description
+Action Inserts a new preview inset.
+\end_layout
+\begin_layout Description
+Syntax preview-insert
+\end_layout
+\begin_layout Description
+Origin vfr, 28 Mar 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_TAB_INSERT
\end_layout
Syntax info-insert <TYPE> <ARG>
\end_layout
\begin_layout Description
-Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
+Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
\begin_inset Newline newline
\end_inset
lyxrc: name of rc_entry (e.g. bind_file)
\begin_inset Newline newline
+\end_inset
+
+ lyxinfo: "version" - used version of LyX
+\begin_inset Newline newline
\end_inset
package: name of latex package (e.g. listings)
For dissolving the element see LFUN_INSET_DISSOLVE.
\end_layout
\begin_layout Description
-Syntax flex-insert <TYPE:Name>
+Syntax flex-insert Name
\end_layout
\begin_layout Description
-Params TYPE: CharStyle|Custom|Element|Standard
-\begin_inset Newline newline
-\end_inset
-
-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.
-\begin_inset Newline newline
-\end_inset
-
-Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
+Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
\end_layout
\begin_layout Description
-Sample flex-insert CharStyle:Code
+Sample flex-insert Code
\end_layout
\begin_layout Subsection*
\end_layout
\begin_layout Subsection*
-LFUN_TOC_INSERT
+LFUN_SCRIPT_INSERT
\end_layout
\begin_layout Description
-Action Inserts table of contents.
+Action Inserts a subscript or superscript inset.
\end_layout
\begin_layout Description
-Syntax toc-insert
+Syntax script-insert <TYPE>
\end_layout
\begin_layout Description
-Origin Lgb, 27 May 97
+Params <TYPE>: subscript|superscript
+\end_layout
+\begin_layout Description
+Origin Georg, 23 Nov 2010
\end_layout
\begin_layout Subsection*
LFUN_ESCAPE
\end_layout
\begin_layout Description
-Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
+Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
\end_layout
\begin_layout Description
Syntax escape
Origin JSpitzm, 18 Jan 2010
\end_layout
+\begin_layout Subsection*
+LFUN_SPELLING_REMOVE
+\end_layout
+\begin_layout Description
+Action Remove the word under the cursor from the respective spell checker dictionary.
+\end_layout
+\begin_layout Description
+Syntax spelling-remove [<STRING>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to remove <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin SWitt, 28 July 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_THESAURUS_ENTRY
\end_layout
Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
\end_layout
\begin_layout Description
-Origin baum, 10 Jul 2006
+Origin Georg, 10 Jul 2006
\end_layout
\begin_layout Subsection*
LFUN_PRIMARY_SELECTION_PASTE
\end_layout
\begin_layout Description
-Action Pastes the currently text selected text.
+Action Pastes the currently selected text.
\end_layout
\begin_layout Description
Notion Primary selection mechanism is linux-only thing.
LFUN_SELECTION_PASTE
\end_layout
\begin_layout Description
-Action Pastes the text in permanent selection.
+Action Pastes the the internal selection text in permanent selection.
+\end_layout
+\begin_layout Description
+Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
\end_layout
\begin_layout Description
Syntax selection-paste
\end_layout
+\begin_layout Description
+Origin lasgouttes, 14 Jan 2009
+\end_layout
\begin_layout Subsection*
LFUN_UNDO
LFUN_MATH_SUPERSCRIPT
\end_layout
\begin_layout Description
-Action Enters subscript expression in math expression.
+Action Enters superscript expression in math expression.
\end_layout
\begin_layout Description
Syntax math-superscript
Syntax math-font-style <STYLE>
\end_layout
\begin_layout Description
-Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
+Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
+\begin_inset Newline newline
+\end_inset
+
+|textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
\end_layout
\begin_layout Description
Origin vfr, 9 jan 2009
LFUN_VC_REGISTER
\end_layout
\begin_layout Description
-Action Register the document as an file inside version control system (RCS, CVS).
+Action Register the document as an file inside version control system.
\end_layout
\begin_layout Description
Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
LFUN_VC_CHECK_OUT
\end_layout
\begin_layout Description
-Action Checks-out the document for edit (and locks it for RCS).
-\end_layout
-\begin_layout Description
-Notion This is implemented only for RCS and SVN, not CVS.
+Action Checks-out the document for edit (and locks it in some cases).
\end_layout
\begin_layout Description
Syntax vc-check-out
Action Update the local archive directory in which resides the current document with the remote repository.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for SVN.
-\end_layout
-\begin_layout Description
Syntax vc-repo-update
\end_layout
\begin_layout Description
Action Compares two revisions of the same file under version control.
\end_layout
\begin_layout Description
-Notion This is currently implemented only for SVN and RCS.
-\end_layout
-\begin_layout Description
-Syntax vc-compare <REV1> [<REV2>]
+Syntax vc-compare [<REV1>] [<REV2>]
\end_layout
\begin_layout Description
-Params Revision number either points directly to commit in history or if negative number -x it points to last commit - x.
+Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
\begin_inset Newline newline
\end_inset
\end_inset
<REV2>: Newer file. Used only if REV1 > 0.
+\begin_inset Newline newline
+\end_inset
+
+If no parameter is given, interactive dialog will be shown.
\end_layout
\begin_layout Description
Sample Compare current document against last commit
\begin_inset Newline newline
\end_inset
-vc-compare 0Compare current document against current revision - 5 commits
+ vc-compare 0
+\begin_inset Newline newline
+\end_inset
+
+Compare current document against current revision - 5 commits
\begin_inset Newline newline
\end_inset
-vc-compare -5Compare revisions 120 and 155
+ vc-compare -5
\begin_inset Newline newline
\end_inset
-vc-compare 120 155
+Compare revisions 120 and 155
+\begin_inset Newline newline
+\end_inset
+
+ vc-compare 120 155
\end_layout
\begin_layout Description
Origin sanda, 12 Feb 2010
Action Rejects tracked change inside the selection.
\end_layout
\begin_layout Description
-Syntax change-accept
+Syntax change-reject
\end_layout
\begin_layout Description
Origin Levon, 16 Oct 2002
Syntax inset-insert <INSET> <ARGS>
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular hyperlink|include|index|label|nomencl|vspace|ref|toc>
+Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|
+\begin_inset Newline newline
+\end_inset
+
+ hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
\begin_inset Newline newline
\end_inset
\begin_inset Newline newline
\end_inset
-prettyref -- Formatted reference
+formatted -- Formatted reference
\end_layout
\begin_layout Subsection*
\begin_inset Newline newline
\end_inset
-<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|valign-top|valign-bottom| valign-middle|longtabular-align-left|longtabular-align-center| longtabular-align-right|m-align-left|m-align-right|m-align-center| m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|set-all-lines| unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| 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
+<FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| align-left|align-right|align-center|align-block|align-decimal|set-decimal-point| valign-top|valign-bottom|valign-middle|longtabular-align-left| longtabular-align-center|longtabular-align-right|m-align-left|m-align-right| m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn| set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth| set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| 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|set-tabular-width
\begin_inset Newline newline
\end_inset
<ARG>: additional argument for some commands, use debug mode to explore its values.
\end_layout
\begin_layout Description
-Sample inset-modify note Note Commentinset-modify changetype Ovalbox
+Sample inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+ inset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
Action Open the inset's properties dialog.
\end_layout
\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
+Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
\end_layout
\begin_layout Description
Syntax inset-settings <INSET>
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float| graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|tabular|vspace|wrap>.
+Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
+\begin_inset Newline newline
+\end_inset
+
+graphics|href|include|index|index_print|label|line| listings|note|phantom|ref|space|tabular|vspace|wrap>.
\end_layout
\begin_layout Subsection*
Origin lasgouttes, 19 Jul 2001
\end_layout
-\begin_layout Subsection*
-LFUN_ALL_INSETS_TOGGLE
-\end_layout
-\begin_layout Description
-Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
-\end_layout
-\begin_layout Description
-Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
-\end_layout
-\begin_layout Description
-Syntax all-insets-toggle [<STATE>] [<INSET>]
-\end_layout
-\begin_layout Description
-Params <STATE>: <toggle|open|close|assign> default: toggle
-\begin_inset Newline newline
-\end_inset
-
-<INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
-\end_layout
-\begin_layout Description
-Origin leeming, 30 Mar 2004
-\end_layout
-
\begin_layout Subsection*
LFUN_INSET_FORALL
\end_layout
Action Apply the given commands on insets of a given name.
\end_layout
\begin_layout Description
-Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000.
+Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed.
\end_layout
\begin_layout Description
Syntax inset-forall <NAME> <LFUN-COMMAND>
\begin_inset Newline newline
\end_inset
-inset-forall Note:Note inset-modify note Note Comment
+ inset-forall Note:Note inset-modify note Note Comment
\begin_inset Newline newline
\end_inset
Syntax toolbar-toggle <NAME> [allowauto]
\end_layout
\begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
+Params <NAME>: standard|extra|table|math|mathmacrotemplate|
+\begin_inset Newline newline
+\end_inset
+
+minibuffer|review|view/update|math_panels|vcs| view-others|update-others
\end_layout
\begin_layout Description
Origin Edwin, 21 May 2007
\begin_inset Newline newline
\end_inset
-graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|
+graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
\begin_inset Newline newline
\end_inset
LFUN_SERVER_GOTO_FILE_ROW
\end_layout
\begin_layout Description
-Action Sets the cursor position based on the row number of generated TeX file.
+Action Sets the cursor position in LyX based on the row number of generated TeX file.
\end_layout
\begin_layout Description
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).
Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
\end_layout
\begin_layout Description
-Params <FILE>: the 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.
+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.
\begin_inset Newline newline
\end_inset
-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. <ROW_NUMBER> The row number of the LaTeX file to which to go.
+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).
+\begin_inset Newline newline
+\end_inset
+
+.ext: extensions will be automatically replaced by .lyx.
+\begin_inset Newline newline
+\end_inset
+
+<ROW_NUMBER> The row number of the LaTeX file to which to go.
+\end_layout
+\begin_layout Description
+Sample server-goto-file-row /home/user/example.lyx 41
+\begin_inset Newline newline
+\end_inset
+
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
\end_layout
\begin_layout Description
Origin Edmar, 23 Dec 1998
\end_layout
+\begin_layout Subsection*
+LFUN_FORWARD_SEARCH
+\end_layout
+\begin_layout Description
+Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
+\end_layout
+\begin_layout Description
+Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these settings.
+\end_layout
+\begin_layout Description
+Syntax forward-search
+\end_layout
+\begin_layout Description
+Origin sanda, 14 Apr 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_SERVER_NOTIFY
\end_layout
Origin bpeng, 27 Apr 2006
\end_layout
+\begin_layout Subsection*
+LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
+\end_layout
+\begin_layout Description
+Action Toggles including of resources for forward/reverse search of the given document.
+\end_layout
+\begin_layout Description
+Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
+\end_layout
+\begin_layout Description
+Syntax buffer-toggle-output-sync
+\end_layout
+\begin_layout Description
+Origin sanda, 25 May 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_BUFFER_CLOSE
\end_layout
Origin vfr, 30 Mar 2009
\end_layout
+\begin_layout Subsection*
+LFUN_INSET_COPY_AS
+\end_layout
+\begin_layout Description
+Action Copies the inset to the clipboard as a certain type.
+\end_layout
+\begin_layout Description
+Notion Currently used only for InsetInfo where its content is copied as a text.
+\end_layout
+\begin_layout Description
+Syntax inset-copy-as
+\end_layout
+\begin_layout Description
+Origin vfr, 18 Apr 2010
+\end_layout
+
\end_body
\end_document
projects / lyx.git / blobdiff