]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/LFUNs.lyx
A couple minor changes in the User's Guide.
[lyx.git] / lib / doc / LFUNs.lyx
index c5eb844047d18010dd94bd41af824e8529e70ae3..75d9b06dc4745292b0136441b00c4fd2cdc93a1f 100644 (file)
@@ -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-06-28
+LFUNs documentation automatically generated 2009-10-20
 \end_layout
 
 \begin_layout Standard
@@ -512,11 +520,41 @@ Notion Apart from lfun arguments you can use the following method:
 Syntax info-insert <TYPE> <ARG>
 \end_layout
 \begin_layout Description
-Params <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer
+Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
 \begin_inset Newline newline
 \end_inset
 
 <ARG>: 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
+
+                     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"
 \end_layout
 \begin_layout Description
 Sample command-sequence info-insert buffer path; info-insert buffer name
@@ -1186,11 +1224,11 @@ Action Replace a string in the document.
 Syntax word-replace [<DATA>]
 \end_layout
 \begin_layout Description
-Params <DATA>: data is of the form "<search>
+Params <DATA>: data is of the form "<replace>
 \begin_inset Newline newline
 \end_inset
 
-<replace>
+<search>
 \begin_inset Newline newline
 \end_inset
 
@@ -1457,6 +1495,19 @@ 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_LINE_BEGIN
 \end_layout
@@ -2317,6 +2368,22 @@ Params <ALIGN>: 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 <COLS> <ROWS> [<DECORATION>]
+\end_layout
+\begin_layout Description
+Params <DECORATION>: 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
@@ -2763,16 +2830,6 @@ Params <PAR_ID_NUMBER>:  paragraph id
 Origin Dekel, 26 Aug 2000
 \end_layout
 
-\begin_layout Subsection*
-LFUN_BREAK_PARAGRAPH
-\end_layout
-\begin_layout Description
-Action Breaks the current paragraph at the current location.
-\end_layout
-\begin_layout Description
-Syntax break-paragraph
-\end_layout
-
 \begin_layout Subsection*
 LFUN_BREAK_PARAGRAPH
 \end_layout
@@ -2816,7 +2873,7 @@ leftindent LENGTH
 
 <SPACING>: 
 \backslash
-paragraph_spacing default|single|onehalf|double|other
+paragraph_spacing default|single|onehalf|double|other SIZE
 \begin_inset Newline newline
 \end_inset
 
@@ -3004,7 +3061,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|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-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
 
@@ -3194,6 +3251,22 @@ Syntax vc-locking-toggle
 Origin sanda, 25 Jun 2009
 \end_layout
 
+\begin_layout Subsection*
+LFUN_VC_REPO_UPDATE
+\end_layout
+\begin_layout Description
+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
+Origin sanda, 16 Oct 2009
+\end_layout
+
 \begin_layout Subsection*
 LFUN_CHANGES_TRACK
 \end_layout
@@ -4137,11 +4210,11 @@ 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 expaned in the path. In case this LFUN does not work make sure you are giving correct path to the file.
+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.
 \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.
+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.
 \end_layout
 \begin_layout Description
 Origin Edmar, 23 Dec 1998
@@ -4288,6 +4361,19 @@ Notion Closes the current buffer, asking whether to save it, etc, if the buffer
 Syntax buffer-close
 \end_layout
 
+\begin_layout Subsection*
+LFUN_BUFFER_CLOSE_ALL
+\end_layout
+\begin_layout Description
+Action Closes all buffers.
+\end_layout
+\begin_layout Description
+Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
+\end_layout
+\begin_layout Description
+Syntax buffer-close-all
+\end_layout
+
 \begin_layout Subsection*
 LFUN_BUFFER_EXPORT
 \end_layout
@@ -4963,7 +5049,7 @@ Origin sts, Feb 19 2008
 LFUN_COMPLETION_CANCEL
 \end_layout
 \begin_layout Description
-Action Try to cancel completion, either the popup or the inline completion
+Action Try to cancel completion, either the popup or the inline completion.
 \end_layout
 \begin_layout Description
 Syntax completion-cancel
@@ -4985,11 +5071,27 @@ Syntax completion-accept
 Origin sanda, Sep 08 2008
 \end_layout
 
+\begin_layout Subsection*
+LFUN_BRANCH_ADD
+\end_layout
+\begin_layout Description
+Action Add a branch to the buffer's BranchList.
+\end_layout
+\begin_layout Description
+Syntax branch-add <BRANCH>
+\end_layout
+\begin_layout Description
+Params <BRANCH>: Name of the branch to add
+\end_layout
+\begin_layout Description
+Origin spitz, 7 Jul 2009
+\end_layout
+
 \begin_layout Subsection*
 LFUN_BRANCH_ACTIVATE
 \end_layout
 \begin_layout Description
-Action Activate the branch
+Action Activate the branch.
 \end_layout
 \begin_layout Description
 Syntax branch-activate <BRANCH>
@@ -5012,7 +5114,7 @@ Origin rgh, 27 May 2008
 LFUN_BRANCH_DEACTIVATE
 \end_layout
 \begin_layout Description
-Action De-activate the branch
+Action De-activate the branch.
 \end_layout
 \begin_layout Description
 Syntax branch-deactivate <BRANCH>
@@ -5024,6 +5126,38 @@ Params <BRANCH>: The branch to deactivate
 Origin rgh, 27 May 2008
 \end_layout
 
+\begin_layout Subsection*
+LFUN_BRANCHES_RENAME
+\end_layout
+\begin_layout Description
+Action Rename all branches of a given name in a document.
+\end_layout
+\begin_layout Description
+Syntax branches-rename <OLDNAME> <NEWNAME>
+\end_layout
+\begin_layout Description
+Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
+\end_layout
+\begin_layout Description
+Origin spitz, 9 Jul 2009
+\end_layout
+
+\begin_layout Subsection*
+LFUN_BRANCH_ADD_INSERT
+\end_layout
+\begin_layout Description
+Action Create new branch and directly put the branch inset into the document.
+\end_layout
+\begin_layout Description
+Syntax branch-add-insert [<NAME>]
+\end_layout
+\begin_layout Description
+Params <NAME>: Branch name. If it is not specified, you will be asked.
+\end_layout
+\begin_layout Description
+Origin sanda, 10 Jul 2009
+\end_layout
+
 \begin_layout Subsection*
 LFUN_LABEL_COPY_AS_REF
 \end_layout
@@ -5101,5 +5235,18 @@ Syntax section-select
 Origin vfr, 05 May 2009
 \end_layout
 
+\begin_layout Subsection*
+LFUN_GRAPHICS_RELOAD
+\end_layout
+\begin_layout Description
+Action Reloads the image if necessary.
+\end_layout
+\begin_layout Description
+Syntax graphics-reload
+\end_layout
+\begin_layout Description
+Origin vfr, 10 Aug 2009
+\end_layout
+
 \end_body
 \end_document