X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=b29644ed1f997440ea950db6d3259caf03ec8ae8;hb=83145d8ab1e7d1132163d3aad66e9c91502e8c9e;hp=561da60374bc78f0386b850b58fdc388467083ac;hpb=42509803dc64047933736c8a6e7fbddcb0ad2fff;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index 561da60374..b29644ed1f 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -2,11 +2,18 @@ \lyxformat 345 \begin_document \begin_header -\textclass amsart +\textclass article +\begin_preamble +\renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:} +\renewenvironment{description}{\list{}{% + \setlength{\itemsep}{-2pt} + \advance\leftmargini6\p@ \itemindent-12\p@ + \labelwidth\z@ \let\makelabel\descriptionlabel}% +}{ + \endlist +} +\end_preamble \use_default_options false -\begin_modules -theorems-ams -\end_modules \language english \inputencoding auto \font_roman default @@ -20,6 +27,7 @@ theorems-ams \graphics default \paperfontsize default +\spacing single \use_hyperref false \papersize default \use_geometry true @@ -49,7 +57,7 @@ theorems-ams \begin_body \begin_layout Section* -LFUNs documentation automatically generated 2009-05-23 +LFUNs documentation automatically generated 2011-03-04 \end_layout \begin_layout Standard @@ -357,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 @@ -443,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 @@ -512,11 +520,45 @@ Notion Apart from lfun arguments you can use the following method: Syntax info-insert \end_layout \begin_layout Description -Params : shortcut|lyxrc|package|textclass|menu|buffer +Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \begin_inset Newline newline \end_inset : argument for a given type. Look into InsetInfo.h for detailed description. +\begin_inset Newline newline +\end_inset + + shortcut[s]: name of lfun (e.g math-insert +\backslash +alpha) +\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) +\begin_inset Newline newline +\end_inset + + textclass: name of textclass (e.g. article) +\begin_inset Newline newline +\end_inset + + menu: name of lfun used in menu +\begin_inset Newline newline +\end_inset + + icon: name of lfun used in toolbar +\begin_inset Newline newline +\end_inset + + 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 @@ -576,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* @@ -659,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* @@ -771,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 @@ -823,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 @@ -1186,11 +1207,11 @@ Action Replace a string in the document. Syntax word-replace [] \end_layout \begin_layout Description -Params : data is of the form " +Params : data is of the form " \begin_inset Newline newline \end_inset - + \begin_inset Newline newline \end_inset @@ -1349,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 @@ -1457,6 +1526,35 @@ Syntax inset-end-select Origin lasgouttes, 16 Mar 2009 \end_layout +\begin_layout Subsection* +LFUN_INSET_SELECT_ALL +\end_layout +\begin_layout Description +Action Selects all contents of an inset. +\end_layout +\begin_layout Description +Syntax inset-select-all +\end_layout +\begin_layout Description +Origin vfr, 22 Aug 2009 +\end_layout + +\begin_layout Subsection* +LFUN_SECTION_SELECT +\end_layout +\begin_layout Description +Action Selects the whole section. +\end_layout +\begin_layout Description +Notion The cursor should be in a section heading before calling this lfun. +\end_layout +\begin_layout Description +Syntax section-select +\end_layout +\begin_layout Description +Origin vfr, 05 May 2009 +\end_layout + \begin_layout Subsection* LFUN_LINE_BEGIN \end_layout @@ -1557,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. @@ -1580,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 @@ -2169,6 +2273,15 @@ LFUN_MATH_INSERT Action Inserts math objects and symbols. \end_layout \begin_layout Description +Notion When is a _single_ math inset with more than one cell (such as "x_y^z" or " +\backslash +frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert +\backslash +frac{x}{y}" replaces "abc" with " +\backslash +frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected. +\end_layout +\begin_layout Description Syntax math-insert \end_layout \begin_layout Description @@ -2192,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 @@ -2308,6 +2421,22 @@ Params : Alignment is a word composed of the vertical alignment (b, c or Sample math-matrix 3 3 bccc \end_layout +\begin_layout Subsection* +LFUN_MATH_AMS_MATRIX +\end_layout +\begin_layout Description +Action Inserts a matrix. +\end_layout +\begin_layout Description +Syntax math-matrix [] +\end_layout +\begin_layout Description +Params : Decoration determines the LaTeX name of the matrix that should be created. +\end_layout +\begin_layout Description +Sample math-ams-matrix 3 3 bmatrix +\end_layout + \begin_layout Subsection* LFUN_MATH_MODE \end_layout @@ -2318,10 +2447,14 @@ Action In text mode enters math mode (i.e. puts math insets on the current curso Notion If there is some selected text, it puts the text inside created math box. \end_layout \begin_layout Description -Syntax math-mode [] +Syntax math-mode [on|] \end_layout \begin_layout Description Params : eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT . +\begin_inset Newline newline +\end_inset + +"on": allow only entering of math mode from text mode. \end_layout \begin_layout Description Origin Alejandro, 4 Jun 1996 @@ -2441,7 +2574,11 @@ Action Changes the text style used in math. Syntax math-font-style