]> git.lyx.org Git - features.git/commitdiff
* LFUNs.lyx
authorPavel Sanda <sanda@lyx.org>
Fri, 12 Feb 2010 08:45:19 +0000 (08:45 +0000)
committerPavel Sanda <sanda@lyx.org>
Fri, 12 Feb 2010 08:45:19 +0000 (08:45 +0000)
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@33440 a592a061-630c-0410-9148-cb99ea01b6c8

lib/doc/LFUNs.lyx
src/LyXAction.cpp

index be69cb41a7a1e016189ee980a088a4013f252cef..77a701a6e76a273673d8579bca079d713c904f8f 100644 (file)
@@ -57,7 +57,7 @@
 \begin_body
 
 \begin_layout Section*
-LFUNs documentation automatically generated 2010-01-10
+LFUNs documentation automatically generated 2010-02-12
 \end_layout
 
 \begin_layout Standard
@@ -554,7 +554,7 @@ alpha)
 \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
@@ -809,22 +809,6 @@ Action Moves the cursor to the begining of next Note inset.
 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
@@ -1387,6 +1371,38 @@ Action Change the words in the selection or from the cursor position to the end
 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
@@ -3005,29 +3021,6 @@ Syntax outline-out
 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
@@ -3077,7 +3070,7 @@ Notion Various math-environment features are handled here as well, e.g. add-vlin
 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
+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-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
 
@@ -3242,7 +3235,7 @@ M - Message - ask for input string (commit message)
 \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"
@@ -3493,35 +3486,19 @@ prettyref -- Formatted reference
 LFUN_INSET_MODIFY
 \end_layout
 \begin_layout Description
-Action Modify existing 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.
-\end_layout
-\begin_layout Description
-Syntax inset-modify <INSET> <ARGS>
-\end_layout
-\begin_layout Description
-Params See LFUN_INSET_INSERT for further details.
-\end_layout
-
-\begin_layout Subsection*
-LFUN_NEXT_INSET_MODIFY
-\end_layout
-\begin_layout Description
-Action Modify the inset at cursor position, if there is one.
+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 next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
+Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>
 \end_layout
 \begin_layout Description
 Params See LFUN_INSET_INSERT for further details.
 \end_layout
 \begin_layout Description
-Origin JSpitzm, 23 Mar 2008
+Sample inset-modify note Note Commentinset-modify changetype Ovalbox
 \end_layout
 
 \begin_layout Subsection*
@@ -3636,6 +3613,14 @@ Close all Notes (also works for a particular branch, for example):
 \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
@@ -4584,16 +4569,13 @@ Origin Asger, 2 Feb 1997
 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*
index acadc934a6f6482759a0490ed62a2ae8c6300fb3..9c4ce5d353dee40a9ae356d1dba710b920df678e 100644 (file)
@@ -416,7 +416,7 @@ void LyXAction::init()
                      menu: name of lfun used in menu  \n
                      icon: name of lfun used in toolbar \n
                      buffer: "name"|"path"|"class"|"vcs-tree-revision"|
-                             "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
+                              "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
  * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
  * \li Origin: bpeng, 7 Oct 2007
  * \endvar