X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=b29644ed1f997440ea950db6d3259caf03ec8ae8;hb=83145d8ab1e7d1132163d3aad66e9c91502e8c9e;hp=30244c0b6b05f9fd55fc14bfb98ec1d9d9857163;hpb=c29450250e395c90ed656db42ef2fce647d0ae73;p=lyx.git

diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx
index 30244c0b6b..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-09-12
+LFUNs documentation automatically generated 2011-03-04
 \end_layout
 
 \begin_layout Standard
@@ -618,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 <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*
@@ -700,6 +692,22 @@ Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
 Origin JSpitzm, 6 Dec 2007
 \end_layout
 
+\begin_layout Subsection*
+LFUN_SCRIPT_INSERT
+\end_layout
+\begin_layout Description
+Action Inserts a subscript or superscript inset.
+\end_layout
+\begin_layout Description
+Syntax script-insert <TYPE>
+\end_layout
+\begin_layout Description
+Params <TYPE>: subscript|superscript
+\end_layout
+\begin_layout Description
+Origin Georg, 23 Nov 2010
+\end_layout
+
 \begin_layout Subsection*
 LFUN_APPENDIX
 \end_layout
@@ -1647,14 +1655,14 @@ Syntax clipboard-paste [<ARG>]
 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.
@@ -1670,11 +1678,17 @@ Params <ARG>: "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
@@ -2291,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
@@ -2560,7 +2574,11 @@ Action Changes the text style used in math.
 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
@@ -3107,7 +3125,7 @@ Origin Ale, 15 May 1997
 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.
@@ -3143,10 +3161,7 @@ Origin Lgb, 1 Jul 1997
 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
@@ -3254,9 +3269,6 @@ LFUN_VC_REPO_UPDATE
 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
@@ -3270,9 +3282,6 @@ LFUN_VC_COMPARE
 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
@@ -3299,15 +3308,23 @@ 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 -5
 \begin_inset Newline newline
 \end_inset
 
-vc-compare -5Compare revisions 120 and 155
+Compare revisions 120 and 155
 \begin_inset Newline newline
 \end_inset
 
-vc-compare 120 155
+	       vc-compare 120 155
 \end_layout
 \begin_layout Description
 Origin sanda, 12 Feb 2010
@@ -3398,7 +3415,7 @@ LFUN_CHANGE_REJECT
 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
@@ -3479,7 +3496,11 @@ Action Insert new inset (type given by the parameters).
 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|line|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
 
@@ -3516,7 +3537,7 @@ vref -- <reference> on <page>
 \begin_inset Newline newline
 \end_inset
 
-prettyref -- Formatted reference
+formatted -- Formatted reference
 \end_layout
 
 \begin_layout Subsection*
@@ -3540,14 +3561,18 @@ In case that <INSET> is "tabular" various math-environment features are handled
 \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|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
+<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*
@@ -3579,7 +3604,11 @@ Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, gr
 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|line| 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*
@@ -3643,7 +3672,7 @@ Transform all yellow notes to comments
 \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
 
@@ -3889,7 +3918,11 @@ Notion Skipping "auto" when allowauto is false.
 Syntax toolbar-toggle <NAME> [allowauto]
 \end_layout
 \begin_layout Description
-Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs| view-others|update-others
+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
@@ -4284,7 +4317,7 @@ Syntax server-get-filename
 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).
@@ -4293,11 +4326,26 @@ Notion This can be useful for DVI inverse-search or detection of the problematic
 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).
+\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
 
-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.
+server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
 \end_layout
 \begin_layout Description
 Origin Edmar, 23 Dec 1998
@@ -4307,22 +4355,10 @@ Origin Edmar, 23 Dec 1998
 LFUN_FORWARD_SEARCH
 \end_layout
 \begin_layout Description
-Action Sets the cursor position in the previewed (e.g. dvi) file based on the row number in LyX window.
+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 
-\backslash
-forward_search_dvi and 
-\backslash
-forward_search_pdf RC settings. By default, the value for pdf is empty, while for dvi it is
-\begin_inset Newline newline
-\end_inset
-
-"xdvi -sourceposition $$n:$$t $$o"
-\begin_inset Newline newline
-\end_inset
-
-The values replaced in the call: $$n for row number, $$t for exported temporary .tex file, $$o exported output file, either dvi or pdf, depending on which one exists in the temp dir (preferred is dvi).
+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
@@ -5359,16 +5395,13 @@ Origin vfr, 30 Mar 2009
 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
-Syntax inset-copy-as [<TYPE>]
+Action Copies the inset to the clipboard as a certain type.
 \end_layout
 \begin_layout Description
-Params <TYPE>: The type as which the inset is copied. This can vary from inset to inset.
+Notion Currently used only for InsetInfo where its content is copied as a text.
 \end_layout
 \begin_layout Description
-Sample InsetInfo is copied as text
+Syntax inset-copy-as
 \end_layout
 \begin_layout Description
 Origin vfr, 18 Apr 2010