\begin_body
\begin_layout Section*
-LFUNs documentation automatically generated 2010-01-10
+LFUNs documentation automatically generated 2010-02-28
\end_layout
\begin_layout Standard
\begin_inset Newline newline
\end_inset
- buffer: "name"|"path"|"class"
+ buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
\end_layout
\begin_layout Description
Sample command-sequence info-insert buffer path; info-insert buffer name
Syntax note-next
\end_layout
-\begin_layout Subsection*
-LFUN_NOTES_MUTATE
-\end_layout
-\begin_layout Description
-Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
-\end_layout
-\begin_layout Description
-Syntax notes-mutate <SOURCE> <TARGET>
-\end_layout
-\begin_layout Description
-Params <SOURCE/TARGET>: Note|Comment|Greyedout
-\end_layout
-\begin_layout Description
-Origin sanda, 18 Jun 2008
-\end_layout
-
\begin_layout Subsection*
LFUN_PHANTOM_INSERT
\end_layout
Syntax word-lowcase
\end_layout
+\begin_layout Subsection*
+LFUN_SPELLING_ADD
+\end_layout
+\begin_layout Description
+Action Add the word under the cursor to the respective spell checker dictionary.
+\end_layout
+\begin_layout Description
+Syntax spelling-add [<STRING>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to add <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
+\begin_layout Subsection*
+LFUN_SPELLING_IGNORE
+\end_layout
+\begin_layout Description
+Action Let the spell checker ignore the word under the cursor in the current session for the given language.
+\end_layout
+\begin_layout Description
+Syntax spelling-ignore [<WORD>] [<LANG>]
+\end_layout
+\begin_layout Description
+Params <WORD>: word to ignore <LANG>: language name (see file languages)
+\end_layout
+\begin_layout Description
+Origin JSpitzm, 18 Jan 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_THESAURUS_ENTRY
\end_layout
Origin Vermeer, 23 Mar 2006
\end_layout
-\begin_layout Subsection*
-LFUN_OUTLINE_DRAGMOVE
-\end_layout
-\begin_layout Description
-Action Moves the document section associated with the specified heading to a specified location. Both the heading and the target paragraph are specified by the paragraph ID numbers.
-\end_layout
-\begin_layout Description
-Notion The heading is a paragraph with style Part/Chapter/Section/ etc. Id number of the paragraph is not the sequential number seen on the screen, but an internal number that is unique for all opened buffers (documents).
-\end_layout
-\begin_layout Description
-Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
-\end_layout
-\begin_layout Description
-Params <PAR_ID_SECTION>: paragraph id of the section heading which is to be moved.
-\begin_inset Newline newline
-\end_inset
-
-<PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved to.
-\end_layout
-\begin_layout Description
-Origin Rob Oakes, 22 June 2009
-\end_layout
-
\begin_layout Subsection*
LFUN_INSET_EDIT
\end_layout
Action Inserts table into the document.
\end_layout
\begin_layout Description
+Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
+\end_layout
+\begin_layout Description
Syntax tabular-insert [<ROWS> <COLUMNS>]
\end_layout
\begin_layout Description
Origin Jug, 12 Apr 2000
\end_layout
-\begin_layout Subsection*
-LFUN_TABULAR_FEATURE
-\end_layout
-\begin_layout Description
-Action Sets various features to the table/cell on the current cursor position.
-\end_layout
-\begin_layout Description
-Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
-\end_layout
-\begin_layout Description
-Syntax tabular-feature <FEATURE> [<ARG>]
-\end_layout
-\begin_layout Description
-Params <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-multi|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
-\begin_inset Newline newline
-\end_inset
-
-<ARG>: additional argument for some commands, use debug mode to explore its values.
-\end_layout
-\begin_layout Description
-Origin Jug, 28 Jul 2000
-\end_layout
-
\begin_layout Subsection*
LFUN_CELL_BACKWARD
\end_layout
\begin_inset Newline newline
\end_inset
-<COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
+<COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
\end_layout
\begin_layout Description
Sample vc-command DR $$p "svn up"
Origin sanda, 16 Oct 2009
\end_layout
+\begin_layout Subsection*
+LFUN_VC_COMPARE
+\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>]
+\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.
+\begin_inset Newline newline
+\end_inset
+
+ In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
+\begin_inset Newline newline
+\end_inset
+
+<REV1>: Older file.
+\begin_inset Newline newline
+\end_inset
+
+ <REV2>: Newer file. Used only if REV1 > 0.
+\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
+\begin_inset Newline newline
+\end_inset
+
+vc-compare -5Compare revisions 120 and 155
+\begin_inset Newline newline
+\end_inset
+
+vc-compare 120 155
+\end_layout
+\begin_layout Description
+Origin sanda, 12 Feb 2010
+\end_layout
+
\begin_layout Subsection*
LFUN_CHANGES_TRACK
\end_layout
Syntax inset-insert <INSET> <ARGS>
\end_layout
\begin_layout Description
-Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
+Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular hyperlink|include|index|label|nomencl|vspace|ref|toc>
\begin_inset Newline newline
\end_inset
LFUN_INSET_MODIFY
\end_layout
\begin_layout Description
-Action Modify existing inset.
+Action Modify some properties of an inset.
\end_layout
\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
+Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
\end_layout
\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>
+Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
\end_layout
\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-\end_layout
+Params Generally see LFUN_INSET_INSERT for further details.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection*
-LFUN_NEXT_INSET_MODIFY
-\end_layout
-\begin_layout Description
-Action Modify the inset at cursor position, if there is one.
-\end_layout
-\begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, label, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
-\end_layout
-\begin_layout Description
-Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
-\end_layout
-\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
+In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
+\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
+\begin_inset Newline newline
+\end_inset
+
+<ARG>: additional argument for some commands, use debug mode to explore its values.
\end_layout
\begin_layout Description
-Origin JSpitzm, 23 Mar 2008
+Sample inset-modify note Note Commentinset-modify changetype Ovalbox
\end_layout
\begin_layout Subsection*
\begin_inset Newline newline
\end_inset
+Transform all yellow notes to comments
+\begin_inset Newline newline
+\end_inset
+
+inset-forall Note:Note inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
Try to put LyX in an infinite loop if there is at least a Note:
\begin_inset Newline newline
\end_inset
LFUN_BUFFER_SWITCH
\end_layout
\begin_layout Description
-Action Switch to the given buffer.
-\end_layout
-\begin_layout Description
-Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
+Action Display/switch to the given buffer.
\end_layout
\begin_layout Description
-Syntax buffer-new-template <BUFFER>
+Syntax buffer-switch <BUFFER>
\end_layout
\begin_layout Description
-Params <BUFFER>: already opened document which is to be shown.
+Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
\end_layout
\begin_layout Subsection*
projects / lyx.git / blobdiff