X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=b29644ed1f997440ea950db6d3259caf03ec8ae8;hb=83145d8ab1e7d1132163d3aad66e9c91502e8c9e;hp=be69cb41a7a1e016189ee980a088a4013f252cef;hpb=5a4f7a89e23308b1f004c58411ee4de45b20f783;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index be69cb41a7..b29644ed1f 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -57,7 +57,7 @@ \begin_body \begin_layout Section* -LFUNs documentation automatically generated 2010-01-10 +LFUNs documentation automatically generated 2011-03-04 \end_layout \begin_layout Standard @@ -365,31 +365,18 @@ Origin Dekel, 7 Apr 2002 \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 @@ -451,6 +438,19 @@ Syntax listing-insert 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 @@ -520,7 +520,7 @@ Notion Apart from lfun arguments you can use the following method: Syntax info-insert \end_layout \begin_layout Description -Params : shortcut[s]|lyxrc|package|textclass|menu|buffer +Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \begin_inset Newline newline \end_inset @@ -536,6 +536,10 @@ alpha) 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) @@ -554,7 +558,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 @@ -614,21 +618,13 @@ To make this command enabled the layout file for the document class you're using For dissolving the element see LFUN_INSET_DISSOLVE. \end_layout \begin_layout Description -Syntax flex-insert +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 +Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. \end_layout \begin_layout Description -Sample flex-insert CharStyle:Code +Sample flex-insert Code \end_layout \begin_layout Subsection* @@ -697,16 +693,19 @@ Origin JSpitzm, 6 Dec 2007 \end_layout \begin_layout Subsection* -LFUN_TOC_INSERT +LFUN_SCRIPT_INSERT +\end_layout +\begin_layout Description +Action Inserts a subscript or superscript inset. \end_layout \begin_layout Description -Action Inserts table of contents. +Syntax script-insert \end_layout \begin_layout Description -Syntax toc-insert +Params : subscript|superscript \end_layout \begin_layout Description -Origin Lgb, 27 May 97 +Origin Georg, 23 Nov 2010 \end_layout \begin_layout Subsection* @@ -809,22 +808,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 -\end_layout -\begin_layout Description -Params : Note|Comment|Greyedout -\end_layout -\begin_layout Description -Origin sanda, 18 Jun 2008 -\end_layout - \begin_layout Subsection* LFUN_PHANTOM_INSERT \end_layout @@ -861,7 +844,7 @@ Origin JSpitzm, 25 Mar 2008 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 @@ -1387,6 +1370,54 @@ 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 [] [] +\end_layout +\begin_layout Description +Params : word to add : 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 [] [] +\end_layout +\begin_layout Description +Params : word to ignore : language name (see file languages) +\end_layout +\begin_layout Description +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 [] [] +\end_layout +\begin_layout Description +Params : word to remove : 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 @@ -1624,14 +1655,14 @@ Syntax clipboard-paste [] Params : "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. @@ -1647,11 +1678,17 @@ Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines" 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 @@ -2268,7 +2305,7 @@ Origin vermeer, 12 Dec 2001 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 @@ -2537,7 +2574,11 @@ Action Changes the text style used in math. Syntax math-font-style