UserGuide - document citation_search_view

[lyx.git] / lib / doc / LFUNs.lyx

diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx
index 066b40906181418a377d3714b14c351c19b35962..10834f1300b2055373a241c84eb51ef108b1f2e1 100644 (file)
--- a/lib/doc/LFUNs.lyx
+++ b/lib/doc/LFUNs.lyx
@@ -1,5 +1,5 @@
 #LyX 2.4 created this file. For more info see https://www.lyx.org/
 #LyX 2.4 created this file. For more info see https://www.lyx.org/

-\lyxformat 600
+\lyxformat 614

 \begin_document
 \begin_header
 \save_transient_properties true
 \begin_document
 \begin_header
 \save_transient_properties true


@@ -114,7 +114,7 @@ About this manual
 \end_layout
 
 \begin_layout Standard
 \end_layout
 
 \begin_layout Standard

-This manual documents the
+This manual documents the 

 \begin_inset Quotes eld
 \end_inset
 
 \begin_inset Quotes eld
 \end_inset
 


@@ -136,7 +136,7 @@ LFUNs are also used in the files that define keyboard shortcuts, menu or
  So if you want to change\SpecialChar breakableslash
 customize the user interface, you need to deal
  with LFUNs.
  So if you want to change\SpecialChar breakableslash
 customize the user interface, you need to deal
  with LFUNs.

- Furthermore, external programs can use LFUNs to communicate with and
+ Furthermore, external programs can use LFUNs to communicate with and 

 \begin_inset Quotes eld
 \end_inset
 
 \begin_inset Quotes eld
 \end_inset
 


@@ -147,7 +147,7 @@ remote-control
  \SpecialChar LyX
  .
  Finally, you can also issue LFUNs directly via the so called mini-buffer
  \SpecialChar LyX
  .
  Finally, you can also issue LFUNs directly via the so called mini-buffer

- which can be opened via
+ which can be opened via 

 \begin_inset Info
 type  "shortcuts"
 arg   "command-execute"
 \begin_inset Info
 type  "shortcuts"
 arg   "command-execute"


@@ -304,6 +304,22 @@ Syntax font-ital
 Origin vermeer, 10 Jan 2002
 \end_layout
 
 Origin vermeer, 10 Jan 2002
 \end_layout
 

+\begin_layout Subsection*
+font-nospellcheck
+\end_layout
+
+\begin_layout Description
+Action Toggles nospellcheck status in the font (selection-wise).
+\end_layout
+
+\begin_layout Description
+Syntax font-nospellcheck
+\end_layout
+
+\begin_layout Description
+Origin spitz, 5 March 2021
+\end_layout
+

 \begin_layout Subsection*
 font-noun
 \end_layout
 \begin_layout Subsection*
 font-noun
 \end_layout


@@ -1401,11 +1417,11 @@ Action Deletes one character in the backward direction (usually the "BackSpace"
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Syntax char-delete-backward [force]
+Syntax char-delete-backward [confirm]

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*


@@ -1417,11 +1433,11 @@ Action Deletes one character in the backward direction (usually the "Delete" key
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Syntax char-delete-forward [force]
+Syntax char-delete-forward [confirm]

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*


@@ -2316,6 +2332,46 @@ Params <TYPE:Name>: name of the index, if multiple indices are defined. With an
 Origin Lgb, 27 Feb 1997
 \end_layout
 
 Origin Lgb, 27 Feb 1997
 \end_layout
 

+\begin_layout Subsection*
+index-tag-all
+\end_layout
+
+\begin_layout Description
+Action Tags all occurrences of the word before the cursor with the index inset at cursor.
+\end_layout
+
+\begin_layout Description
+Notion It automatically takes the word on the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax index-tag-all
+\end_layout
+
+\begin_layout Description
+Origin spitz, 5 Nov 2022
+\end_layout
+
+\begin_layout Subsection*
+indexmacro-insert
+\end_layout
+
+\begin_layout Description
+Action Inserts special Index macros into the document.
+\end_layout
+
+\begin_layout Description
+Syntax indexmacro-insert <type>
+\end_layout
+
+\begin_layout Description
+Params <type>: see, seealso, subentry, sortkey.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 20 Feb 2022
+\end_layout
+

 \begin_layout Subsection*
 info-insert
 \end_layout
 \begin_layout Subsection*
 info-insert
 \end_layout


@@ -2611,11 +2667,11 @@ Sample Remove all index insets:
 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-inset-forall Index char-delete-forward force
+inset-forall Index char-delete-forward

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-Close all Notes (also works for a particular branch, for example):
+Close all Notes:

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 


@@ -2623,6 +2679,14 @@ inset-forall Note inset-toggle close
 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

+Open all branch insets of branch "myBranch":
+\begin_inset Newline newline
+\end_inset
+
+inset-forall Branch:myBranch inset-toggle open
+\begin_inset Newline newline
+\end_inset
+

 Transform all yellow notes to comments
 \begin_inset Newline newline
 \end_inset
 Transform all yellow notes to comments
 \begin_inset Newline newline
 \end_inset


@@ -2700,6 +2764,22 @@ vref -- <reference> on <page>
 formatted -- Formatted reference
 \end_layout
 
 formatted -- Formatted reference
 \end_layout
 

+\begin_layout Subsection*
+inset-insert-copy
+\end_layout
+
+\begin_layout Description
+Action Inserts the inset's content (in ToC pane) at the position of the cursor.
+\end_layout
+
+\begin_layout Description
+Syntax inset-insert-copy
+\end_layout
+
+\begin_layout Description
+Origin spitz, 1 Nov 2022
+\end_layout
+

 \begin_layout Subsection*
 inset-modify
 \end_layout
 \begin_layout Subsection*
 inset-modify
 \end_layout


@@ -3677,7 +3757,7 @@ Action Pastes the currently selected text.
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Notion Primary selection mechanism is linux-only thing.
+Notion Primary selection mechanism is X11/Wayland-only thing.

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description


@@ -3948,6 +4028,26 @@ Params <TYPE>:  line|page
 Origin Abdel, Dec 27 2007
 \end_layout
 
 Origin Abdel, Dec 27 2007
 \end_layout
 

+\begin_layout Subsection*
+search-string-set
+\end_layout
+
+\begin_layout Description
+Action Set search string buffer.
+\end_layout
+
+\begin_layout Description
+Syntax search-string-set [<DATA>]
+\end_layout
+
+\begin_layout Description
+Params <DATA>: string to search for. If no parameter is given, use (word under) selection.
+\end_layout
+
+\begin_layout Description
+Origin stwitt, spitz, Feb 12 2021
+\end_layout
+

 \begin_layout Subsection*
 section-select
 \end_layout
 \begin_layout Subsection*
 section-select
 \end_layout


@@ -4076,6 +4176,26 @@ Params <WORD>: word to add <LANG>: language name (see file languages)
 Origin spitz, 18 Jan 2010
 \end_layout
 
 Origin spitz, 18 Jan 2010
 \end_layout
 

+\begin_layout Subsection*
+spelling-add-local
+\end_layout
+
+\begin_layout Description
+Action Add the word under the cursor to the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-add-local [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to add            <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin spitz, 6 Mar 2021
+\end_layout
+

 \begin_layout Subsection*
 spelling-continuously
 \end_layout
 \begin_layout Subsection*
 spelling-continuously
 \end_layout


@@ -4132,6 +4252,26 @@ Params <WORD>: word to remove <LANG>: language name (see file languages)
 Origin SWitt, 28 July 2010
 \end_layout
 
 Origin SWitt, 28 July 2010
 \end_layout
 

+\begin_layout Subsection*
+spelling-remove-local
+\end_layout
+
+\begin_layout Description
+Action Remove the word under the cursor from the document's local spell checker dictionary. The default for the language is retrieved from the cursor position.
+\end_layout
+
+\begin_layout Description
+Syntax spelling-remove-local [<STRING>] [<LANG>]
+\end_layout
+
+\begin_layout Description
+Params <WORD>: word to remove         <LANG>: language name (see file languages)
+\end_layout
+
+\begin_layout Description
+Origin spitz, 7 Mar 2021
+\end_layout
+

 \begin_layout Subsection*
 tab-delete
 \end_layout
 \begin_layout Subsection*
 tab-delete
 \end_layout


@@ -4229,11 +4369,11 @@ m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-reset-formal-default|set-all-lines|unset-all-lines|toggle-longtabular|
+reset-formal-default|set-all-lines|toggle-all-lines|unset-all-lines|

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-set-longtabular|unset-longtabular|set-pwidth|
+toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth|

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 


@@ -4261,15 +4401,15 @@ toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-set-interline-space|set-border-lines|tabular-valign-top|
+set-interline-space|tabular-valign-top|tabular-valign-middle|

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-tabular-valign-middle|tabular-valign-bottom|set-tabular-width|
+tabular-valign-bottom|set-tabular-width|toggle-varwidth-column|

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-toggle-varwidth-column Various math-environment features are handled as well, e.g. add-vline-left/right for
+set-border-lines|toggle-border-lines|set-inner-lines|toggle-inner-lines Various math-environment features are handled as well, e.g. add-vline-left/right for

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 


@@ -4469,11 +4609,11 @@ Action Deletes characters to the beginning of the word (usually the "C+BackSpace
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Syntax word-delete-backward [force]
+Syntax word-delete-backward [confirm]

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*


@@ -4485,11 +4625,11 @@ Action Deletes characters to the end of the word (usually the "C+Delete" key).
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Syntax word-delete-forward [force]
+Syntax word-delete-forward [confirm]

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params force: Delete big insets, do not only select them.
+Params confirm: Select big insets, do not directly delete them.

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*


@@ -5654,6 +5794,22 @@ Params <BRANCH>: The branch to deactivate
 Origin spitz, 30 Sep 2012
 \end_layout
 
 Origin spitz, 30 Sep 2012
 \end_layout
 

+\begin_layout Subsection*
+branch-sync-all
+\end_layout
+
+\begin_layout Description
+Action Open/close all insets of selected branch (depending on its activation status).
+\end_layout
+
+\begin_layout Description
+Syntax branch-sync-all
+\end_layout
+
+\begin_layout Description
+Origin sanda, 15 April 2022
+\end_layout
+

 \begin_layout Subsection*
 branches-rename
 \end_layout
 \begin_layout Subsection*
 branches-rename
 \end_layout


@@ -5883,7 +6039,7 @@ Params <LFUN-COMMAND>: The command to be applied to the buffers.
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Sample Close all Notes in buffers:
+Sample Close all Notes in all buffers:

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 


@@ -6227,7 +6383,7 @@ Syntax buffer-update [<FORMAT>]
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params <FORMAT>: The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used.
+Params <FORMAT>: The format to display, where this is one of the formats defined in the Tools>Preferences>File Formats dialog,                          use the "Short name" field. If no format is given, the default format as specified in the same dialog is used.

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description


@@ -6287,7 +6443,7 @@ Syntax buffer-write [force]
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params force: write even if buffer is clean.
+Params force: write even if buffer is not marked as modified.

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*


@@ -6530,6 +6686,26 @@ Notion Terminates the current LyX instance, asking whether to save modified docu
 Syntax lyx-quit
 \end_layout
 
 Syntax lyx-quit
 \end_layout
 

+\begin_layout Subsection*
+lyxfiles-open
+\end_layout
+
+\begin_layout Description
+Action Open lyxfiles (templates/examples). Create a view if he have none.
+\end_layout
+
+\begin_layout Description
+Syntax lyxfiles-open [<TYPE>]
+\end_layout
+
+\begin_layout Description
+Params <TYPE>: templates or examples. Default is templates.
+\end_layout
+
+\begin_layout Description
+Origin spitz, 10 Feb 2021
+\end_layout
+

 \begin_layout Subsection*
 master-buffer-export
 \end_layout
 \begin_layout Subsection*
 master-buffer-export
 \end_layout


@@ -6702,6 +6878,30 @@ Syntax tab-group-close
 Origin Abdel, 21 Feb 2008
 \end_layout
 
 Origin Abdel, 21 Feb 2008
 \end_layout
 

+\begin_layout Subsection*
+tab-group-next
+\end_layout
+
+\begin_layout Description
+Action Switch to the next tab group in split view.
+\end_layout
+
+\begin_layout Description
+Syntax tab-group-next
+\end_layout
+
+\begin_layout Subsection*
+tab-group-previous
+\end_layout
+
+\begin_layout Description
+Action Switch to the previous tab group in split view.
+\end_layout
+
+\begin_layout Description
+Syntax tab-group-previous
+\end_layout
+

 \begin_layout Subsection*
 toolbar-movable
 \end_layout
 \begin_layout Subsection*
 toolbar-movable
 \end_layout


@@ -6791,23 +6991,43 @@ Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params statusbar  : Toggle visibility of the statusbar.
+Params statusbar     : Toggle visibility of the statusbar.
+\begin_inset Newline newline
+\end_inset
+
+menubar       : Toggle visibility of the menubar.
+\begin_inset Newline newline
+\end_inset
+
+scrollbar     : Toggle visibility of the scrollbar.
+\begin_inset Newline newline
+\end_inset
+
+frame         : Toggle visibility of the frames around editing window.
+\begin_inset Newline newline
+\end_inset
+
+zoomslider    : Toggle visibility of the zoom slider in statusbar.
+\begin_inset Newline newline
+\end_inset
+
+zoomlevel     : Toggle visibility of the zoom level display in statusbar.

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-menubar    : Toggle visibility of the menubar.
+statistics-w  : Toggle visibility of the document word count in statusbar.

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-scrollbar  : Toggle visibility of the scrollbar.
+statistics-cb : Toggle visibility of the document character count (incl. blanks) in statusbar.

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-frame      : Toggle visibility of the frames around editing window.
+statistics-c  : Toggle visibility of the document character count (excl. blanks) in statusbar.

 \begin_inset Newline newline
 \end_inset
 
 \begin_inset Newline newline
 \end_inset
 

-fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
+fullscreen    : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.

 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description


@@ -6906,6 +7126,26 @@ Origin Abdel, 21 Oct 2006
 System Functions (Preferences, LyX Server etc.)
 \end_layout
 
 System Functions (Preferences, LyX Server etc.)
 \end_layout
 

+\begin_layout Subsection*
+bibtex-database-list
+\end_layout
+
+\begin_layout Description
+Action Lists the available databases (separated by path separator common on the used OS).
+\end_layout
+
+\begin_layout Description
+Notion Used by bibliographic managers
+\end_layout
+
+\begin_layout Description
+Syntax bibtex-database-list
+\end_layout
+
+\begin_layout Description
+Origin bpiwowar, 18 December 2022
+\end_layout
+

 \begin_layout Subsection*
 buffer-toggle-output-sync
 \end_layout
 \begin_layout Subsection*
 buffer-toggle-output-sync
 \end_layout


@@ -7197,7 +7437,11 @@ Syntax search-ignore <type> <value>
 \end_layout
 
 \begin_layout Description
 \end_layout
 
 \begin_layout Description

-Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike<value>: true|false
+Params <type>: language|color|sectioning|font|series|shape|family|markup|underline|strike|deleted|non-output-content
+\begin_inset Newline newline
+\end_inset
+
+<value>: true|false

 \end_layout
 
 \begin_layout Subsection*
 \end_layout
 
 \begin_layout Subsection*