]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/LFUNs.lyx
Add to credit, sorry Edwin your 2c seem to be the only ones
[lyx.git] / lib / doc / LFUNs.lyx
index ce6802f77d71556948318fc2793ab8d2c18d3d56..be69cb41a7a1e016189ee980a088a4013f252cef 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-10-07
+LFUNs documentation automatically generated 2010-01-10
 \end_layout
 
 \begin_layout Standard
@@ -1500,6 +1508,22 @@ Syntax inset-select-all
 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
@@ -3244,16 +3268,16 @@ Origin sanda, 25 Jun 2009
 \end_layout
 
 \begin_layout Subsection*
-LFUN_VC_REPO_SYNCHRO
+LFUN_VC_REPO_UPDATE
 \end_layout
 \begin_layout Description
-Action Synchronize the local archive directory in which resides the current document with the repository.
+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 as revert + update operation.
+Notion This is currently implemented only for SVN.
 \end_layout
 \begin_layout Description
-Syntax vc-repo-synchro
+Syntax vc-repo-update
 \end_layout
 \begin_layout Description
 Origin sanda, 16 Oct 2009
@@ -3579,6 +3603,62 @@ Params <STATE>: <toggle|open|close|assign> default: toggle
 Origin leeming, 30 Mar 2004
 \end_layout
 
+\begin_layout Subsection*
+LFUN_INSET_FORALL
+\end_layout
+\begin_layout Description
+Action Apply the given commands on insets of a given name.
+\end_layout
+\begin_layout Description
+Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000.
+\end_layout
+\begin_layout Description
+Syntax inset-forall <NAME> <LFUN-COMMAND>
+\begin_inset Newline newline
+\end_inset
+
+<NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
+\end_layout
+\begin_layout Description
+Sample Remove all index insets:
+\begin_inset Newline newline
+\end_inset
+
+                  inset-forall Index delete-char-forward
+\begin_inset Newline newline
+\end_inset
+
+Close all Notes (also works for a particular branch, for example):
+\begin_inset Newline newline
+\end_inset
+
+                  inset-forall Note inset-toggle close
+\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
+
+                  inset-forall Note char-backward
+\end_layout
+\begin_layout Description
+Origin lasgouttes, 27 Nov 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
+
 \begin_layout Subsection*
 LFUN_SET_GRAPHICS_GROUP
 \end_layout
@@ -3792,7 +3872,7 @@ LFUN_TOOLBAR_TOGGLE
 Action Toggles visibility of a given toolbar between on/off/auto.
 \end_layout
 \begin_layout Description
-Notion Skiping "auto" when allowauto is false.
+Notion Skipping "auto" when allowauto is false.
 \end_layout
 \begin_layout Description
 Syntax toolbar-toggle <NAME> [allowauto]
@@ -3934,11 +4014,11 @@ Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
 \begin_inset Newline newline
 \end_inset
 
-document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
+compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
 \begin_inset Newline newline
 \end_inset
 
-href|include|index|index_print|info|label|listings|log|mathdelimiter|
+graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|
 \begin_inset Newline newline
 \end_inset
 
@@ -4523,11 +4603,7 @@ LFUN_BUFFER_TOGGLE_READ_ONLY
 Action Toggle editing mode of the current document between read/write and read-only.
 \end_layout
 \begin_layout Description
-Notion In the ->Readonly mode checks-in/commits the data if the file is under version control. In the Readonly-> mode checkouts the data from repository.
-\begin_inset Newline newline
-\end_inset
-
-If these operations fail, buffer won't be toggled.
+Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
 \end_layout
 \begin_layout Description
 Syntax buffer-toggle-read-only
@@ -4832,7 +4908,7 @@ Syntax cancel
 LFUN_COMMAND_EXECUTE
 \end_layout
 \begin_layout Description
-Action Opens the minibuffer toolbar so that the user can type in there.
+Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
 \end_layout
 \begin_layout Description
 Notion Usually bound to M-x shortcut.
@@ -4914,6 +4990,22 @@ Syntax message <STRING>
 Origin Lgb, 8 Apr 2001
 \end_layout
 
+\begin_layout Subsection*
+LFUN_DEBUG_LEVEL_SET
+\end_layout
+\begin_layout Description
+Action Set debug output level.
+\end_layout
+\begin_layout Description
+Syntax debug-level-set <LEVEL>
+\end_layout
+\begin_layout Description
+Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
+\end_layout
+\begin_layout Description
+Origin sanda, 28 Dec 2009
+\end_layout
+
 \begin_layout Subsection*
 LFUN_PREFERENCES_SAVE
 \end_layout
@@ -5211,34 +5303,5 @@ Params <ZOOM>: The zoom in %, the default is 20.
 Origin vfr, 30 Mar 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_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