]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/LFUNs.lyx
UserGuide: minor corrections in the Biblatex passages.
[lyx.git] / lib / doc / LFUNs.lyx
index ff4068ac08d736e4083f713ba4deb7b5b42ea1b1..d95c0b30be6980d8e510aa6cd1dca37c2c05a9bf 100644 (file)
@@ -1,5 +1,5 @@
-#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 506
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 541
 \begin_document
 \begin_header
 \save_transient_properties true
@@ -37,6 +37,8 @@ End
 \font_osf false
 \font_sf_scale 100 100
 \font_tt_scale 100 100
+\use_microtype 0
+\use_dash_ligatures true
 \graphics default
 \default_output_format default
 \output_sync 0
@@ -78,7 +80,8 @@ End
 \tocdepth 3
 \paragraph_separation indent
 \paragraph_indentation default
-\quotes_language english
+\is_math_indent 0
+\quotes_style english
 \papercolumns 1
 \papersides 1
 \paperpagestyle default
@@ -101,10 +104,6 @@ The \SpecialChar LyX
  Team
 \end_layout
 
-\begin_layout Date
-2016-01-27
-\end_layout
-
 \begin_layout Section*
 About this manual
 \end_layout
@@ -220,6 +219,22 @@ Action Toggles the bold font (selection-wise) using boldsymbol in math.
 Syntax font-boldsymbol
 \end_layout
 
+\begin_layout Subsection*
+font-crossout
+\end_layout
+
+\begin_layout Description
+Action Toggles xout (cross-through) in the font (selection-wise).
+\end_layout
+
+\begin_layout Description
+Syntax font-crossout
+\end_layout
+
+\begin_layout Description
+Origin uwestoehr, 4 April 2017
+\end_layout
+
 \begin_layout Subsection*
 font-default
 \end_layout
@@ -1321,7 +1336,11 @@ Action Deletes one character in the backward direction (usually the "BackSpace"
 \end_layout
 
 \begin_layout Description
-Syntax char-delete-backward
+Syntax char-delete-backward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
 \end_layout
 
 \begin_layout Subsection*
@@ -1333,7 +1352,11 @@ Action Deletes one character in the backward direction (usually the "Delete" key
 \end_layout
 
 \begin_layout Description
-Syntax char-delete-forward
+Syntax char-delete-forward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
 \end_layout
 
 \begin_layout Subsection*
@@ -2411,7 +2434,7 @@ Sample Remove all index insets:
 \begin_inset Newline newline
 \end_inset
 
-                  inset-forall Index char-delete-forward
+                  inset-forall Index char-delete-forward force
 \begin_inset Newline newline
 \end_inset
 
@@ -2509,19 +2532,51 @@ Action Modify some properties of an inset.
 \end_layout
 
 \begin_layout Description
-Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
+Notion Used for argument, bibitem, bibtex, box, branch, caption, citation, command, ert, external, float, graphics, include, index, info, label, line, listings, newline, newpage, nomencl, note, phantom, quotes, ref, script, separator, space, tabular, vspace and wrap insets.
 \end_layout
 
 \begin_layout Description
-Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>
+Syntax inset-modify <INSET> <ARGS>
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype <TYPE>
 \end_layout
 
 \begin_layout Description
-Sample inset-modify note Note Comment
+Sample Change a Note inset into a Comment inset:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify note Note Comment
+\begin_inset Newline newline
+\end_inset
+
+Change a Box into an Ovalbox:
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype Ovalbox
+\begin_inset Newline newline
+\end_inset
+
+Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary]
+\begin_inset Newline newline
+\end_inset
+
+inset-modify changetype els
+\begin_inset Newline newline
+\end_inset
+
+Change only the style of a quotation mark, maintaining the other aspects (. = wildcard)
 \begin_inset Newline newline
 \end_inset
 
-              inset-modify changetype Ovalbox
+inset-modify changetype e..
+\begin_inset Newline newline
+\end_inset
+
+
 \end_layout
 
 \begin_layout Subsection*
@@ -3165,27 +3220,27 @@ paragraph-goto
 \end_layout
 
 \begin_layout Description
-Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
+Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph. If given four arguments id_start, pos_start, id_end, pos_end, perform a selection from start to end.
 \end_layout
 
 \begin_layout Description
-Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents).
+Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents). Both ids must belong to the same buffer.
 \end_layout
 
 \begin_layout Description
-Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
+Syntax paragraph-goto <PAR_ID> <POS_IN_PAR> [<PAR_ID> <POS_IN_PAR>]
 \end_layout
 
 \begin_layout Description
-Params <PAR_ID_NUMBER>:  paragraph id
+Params <PAR_ID>:  paragraph id
 \begin_inset Newline newline
 \end_inset
 
-<POSITION_IN_PAR>: desired position within the paragraph
+<POS_IN_PAR>: desired position within the paragraph
 \end_layout
 
 \begin_layout Description
-Origin Dekel, 26 Aug 2000
+Origin Dekel, 26 Aug 2000 gmunch, 5 Sep 2016
 \end_layout
 
 \begin_layout Subsection*
@@ -3417,15 +3472,83 @@ Action Inserts quotes according to the type and quote-language preference.
 \end_layout
 
 \begin_layout Description
-Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
+Notion Currently 15 different quote styles are distinguished (see params).
 \end_layout
 
 \begin_layout Description
-Syntax quote-insert [<TYPE>]
+Syntax quote-insert [<LEVEL>] [<SIDE>] [<STYLE>]
 \end_layout
 
 \begin_layout Description
-Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
+Params <LEVEL>: 'inner' for (i.e., secondary, usually single) quotes, otherwise outer (i.e., primary, usually double) quotes will be used.
+\begin_inset Newline newline
+\end_inset
+
+<SIDE>:  'opening' for opening quotes, 'closing' for closing quotes, otherwise the side will be guessed from the context.
+\begin_inset Newline newline
+\end_inset
+
+<STYLE>: 'british' for `British' quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'cjk' for Chinese/Japanese/Korean corner bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'cjk-angle' for Chinese/Japanese/Korean angle bracket quotation marks
+\begin_inset Newline newline
+\end_inset
+
+'danish' for >>Danish<< quote style (with >inner quotation<)
+\begin_inset Newline newline
+\end_inset
+
+'english' for ``English'' quote style (with `inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'french' for <<french>> quote style (with ``inner quotation'')
+\begin_inset Newline newline
+\end_inset
+
+'frenchin' for <<frenchin>> quote style (with <<inner quotation>>) ["in" = Imprimerie Nationale]
+\begin_inset Newline newline
+\end_inset
+
+'german' for ,,German`` quote style (with ,inner quotation`)
+\begin_inset Newline newline
+\end_inset
+
+'plain' for "Plain" quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'polish' for ,,Polish'' quote style (with ,inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'swedish' for ''Swedish'' quote style (with 'inner quotation')
+\begin_inset Newline newline
+\end_inset
+
+'swedishg' for >>swedishg>> quote style (with 'inner quotation') ["g" = Guillemets]
+\begin_inset Newline newline
+\end_inset
+
+'swiss' for <<Swiss>> quote style (with <inner quotation>)
+\begin_inset Newline newline
+\end_inset
+
+'russian' for <<Russian>> quote style (with ,,inner quotation``)
+\begin_inset Newline newline
+\end_inset
+
+'dynamic' for Dynamic quotation marks which inherit the global document style
+\begin_inset Newline newline
+\end_inset
+
+If no quote style is specified, the document-wide will be used.
 \end_layout
 
 \begin_layout Subsection*
@@ -3464,6 +3587,10 @@ repeat
 Action Repeat the given command.
 \end_layout
 
+\begin_layout Description
+Notion fails when the repeat count is greater than 10000.
+\end_layout
+
 \begin_layout Description
 Syntax repeat <COUNT> <LFUN-COMMAND>
 \end_layout
@@ -3641,7 +3768,7 @@ separator-insert
 \end_layout
 
 \begin_layout Description
-Action Inserts an environment separator or paragraph break.
+Action Inserts an environment separator or latex paragraph break.
 \end_layout
 
 \begin_layout Description
@@ -3649,7 +3776,7 @@ Syntax separator-insert [<ARG>]
 \end_layout
 
 \begin_layout Description
-Params <ARG>: <plain|parbreak> default: plain
+Params <ARG>: <plain|parbreak|latexpar> default: plain
 \end_layout
 
 \begin_layout Description
@@ -3717,7 +3844,7 @@ Syntax specialchar-insert <CHAR>
 \end_layout
 
 \begin_layout Description
-Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator, lyx, tex, latex, latex2e.
+Params <CHAR>: hyphenation, allowbreak, ligature-break, slash,                                            nobreakdash, dots, end-of-sentence, menu-separator,                                     lyx, tex, latex, latex2e.
 \end_layout
 
 \begin_layout Description
@@ -4097,7 +4224,11 @@ Action Deletes characters to the beginning of the word (usually the "C+BackSpace
 \end_layout
 
 \begin_layout Description
-Syntax word-delete-backward
+Syntax word-delete-backward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
 \end_layout
 
 \begin_layout Subsection*
@@ -4109,7 +4240,11 @@ Action Deletes characters to the end of the word (usually the "C+Delete" key).
 \end_layout
 
 \begin_layout Description
-Syntax word-delete-forward
+Syntax word-delete-forward [force]
+\end_layout
+
+\begin_layout Description
+Params force: Delete big insets, do not only select them.
 \end_layout
 
 \begin_layout Subsection*
@@ -5210,6 +5345,22 @@ Params <BRANCH>: The branch to deactivate
 Origin rgh, 27 May 2008
 \end_layout
 
+\begin_layout Subsection*
+branch-invert
+\end_layout
+
+\begin_layout Description
+Action Toggles inversion status of branch inset.
+\end_layout
+
+\begin_layout Description
+Syntax branch-invert
+\end_layout
+
+\begin_layout Description
+Origin rgheck, 12 July 2016
+\end_layout
+
 \begin_layout Subsection*
 branch-master-activate
 \end_layout
@@ -5375,7 +5526,7 @@ Action Exports the current buffer (document) to the given format.
 \end_layout
 
 \begin_layout Description
-Syntax buffer-export <FORMAT> [<DEST>]
+Syntax buffer-export [<FORMAT>] [<DEST>]
 \end_layout
 
 \begin_layout Description
@@ -5383,7 +5534,11 @@ Params <FORMAT> is either "custom" or one of the formats which you can find in T
 \begin_inset Newline newline
 \end_inset
 
-In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.               <DEST>  If present, this argument provides the export destination                       filename. Its containing folder will also be the destination                    folder, where all the needed external files will be copied.
+In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
+\begin_inset Newline newline
+\end_inset
+
+If absent or "default", then the default output format of the document is used.                <DEST>  If present, this argument provides the export destination                       filename. Its containing folder will also be the destination                    folder, where all the needed external files will be copied.
 \end_layout
 
 \begin_layout Description
@@ -5442,6 +5597,22 @@ Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
 Origin leeming, 27 Mar 2004
 \end_layout
 
+\begin_layout Subsection*
+buffer-external-modification-clear
+\end_layout
+
+\begin_layout Description
+Action Clear the external modification flag on the current buffer.
+\end_layout
+
+\begin_layout Description
+Syntax buffer-external-modification-clear
+\end_layout
+
+\begin_layout Description
+Origin gm, 2 March 2017
+\end_layout
+
 \begin_layout Subsection*
 buffer-forall
 \end_layout
@@ -5891,7 +6062,7 @@ Syntax buffer-zoom-in [<ZOOM>]
 \end_layout
 
 \begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Params <ZOOM>: The zoom in % points (neg. or pos.), the default is 20.
 \end_layout
 
 \begin_layout Description
@@ -5911,7 +6082,7 @@ Syntax buffer-zoom-out [<ZOOM>]
 \end_layout
 
 \begin_layout Description
-Params <ZOOM>: The zoom in %, the default is 20.
+Params <ZOOM>: The zoom in % points (neg. or pos.), the default is -20.
 \end_layout
 
 \begin_layout Description
@@ -5994,6 +6165,26 @@ Params <FILE>: any document from (/usr/share/)doc directory.
 Origin Jug, 27 Jun 1999
 \end_layout
 
+\begin_layout Subsection*
+icon-size
+\end_layout
+
+\begin_layout Description
+Action Sets icon size of toolbars.
+\end_layout
+
+\begin_layout Description
+Syntax icon-size [<SIZE>]
+\end_layout
+
+\begin_layout Description
+Params <SIZE> : the icon size in px or one of the logical settings small|normal|big|huge|giant, the default is normal (whose size in px is icon set dependent).
+\end_layout
+
+\begin_layout Description
+Origin 11 July 2016
+\end_layout
+
 \begin_layout Subsection*
 lyx-quit
 \end_layout
@@ -7008,6 +7199,26 @@ This is probably usable only with connection to lyxserver.
 Syntax command-prefix
 \end_layout
 
+\begin_layout Subsection*
+lyx-activate
+\end_layout
+
+\begin_layout Description
+Action Activates the LyX window.
+\end_layout
+
+\begin_layout Description
+Notion On Linux and Mac OS, this action brings the LyX window into focus. Such behavior is not allowed by Windows OS so instead the color of the taskbar entry is changed to indicate that the window has changed in some way. This action is useful in combination with reverse search.
+\end_layout
+
+\begin_layout Description
+Syntax lyx-activate
+\end_layout
+
+\begin_layout Description
+Origin skostysh, 4 Aug 2016
+\end_layout
+
 \begin_layout Subsection*
 self-insert
 \end_layout