X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=68def81b5dbe247b6da7d39b266c91db62c707f5;hb=2e21b10aeddb00aeef391c0666343a80be3e7f52;hp=a529a0aa13ad141459f213af1716354501f1e59b;hpb=4c3b8bf7c7205e26b28b6562be11105558ec3250;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index a529a0aa13..68def81b5d 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -1,5 +1,5 @@ # gen_lfuns.py generated this file. For more info see http://www.lyx.org/ -\lyxformat 504 +\lyxformat 509 \begin_document \begin_header \save_transient_properties true @@ -37,6 +37,7 @@ End \font_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 +\use_microtype 0 \graphics default \default_output_format default \output_sync 0 @@ -101,16 +102,12 @@ The \SpecialChar LyX Team \end_layout -\begin_layout Date -2016-01-15 -\end_layout - \begin_layout Section* About this manual \end_layout \begin_layout Standard -This manual documents the +This manual documents the \begin_inset Quotes eld \end_inset @@ -132,7 +129,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. - 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 @@ -143,7 +140,7 @@ remote-control \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" @@ -169,7 +166,7 @@ Action Displays list of layout choices. \end_layout \begin_layout Description -Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. +Notion This LFUN opens the dropbox allowing for choice of layout. \end_layout \begin_layout Description @@ -185,11 +182,19 @@ Action Splits the current environment with a Separator. \end_layout \begin_layout Description -Syntax environment-split [outer] +Syntax environment-split [before|outer|previous] \end_layout \begin_layout Description -Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. +Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. +\begin_inset Newline newline +\end_inset + +previous: If this is given, LyX will split the environment in the previous paragraph (if there is one). +\begin_inset Newline newline +\end_inset + +before: If this is given, the new environment will be appended rather than prepended. \end_layout \begin_layout Description @@ -220,6 +225,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 @@ -425,11 +446,15 @@ Action Sets the layout (that is, environment) for the current paragraph. \end_layout \begin_layout Description -Syntax layout +Syntax layout [ignorenests] \end_layout \begin_layout Description Params : the layout to use +\begin_inset Newline newline +\end_inset + +ignorenests: If specified, nesting advices will be ignored. \end_layout \begin_layout Subsection* @@ -524,6 +549,34 @@ Syntax layout-tabular Origin Jug, 31 Jul 2000 \end_layout +\begin_layout Subsection* +layout-toggle +\end_layout + +\begin_layout Description +Action Toggles the layout (that is, environment) for the current paragraph. +\end_layout + +\begin_layout Description +Notion Contrary to `layout', this function resets the current (or selection) layout to the standard layout it already has the correct layout. Useful for toolbar icons. +\end_layout + +\begin_layout Description +Syntax layout-toggle [ignorenests] +\end_layout + +\begin_layout Description +Params : the layout to toggle +\begin_inset Newline newline +\end_inset + +ignorenests: If specified, nesting advices will be ignored. +\end_layout + +\begin_layout Description +Origin lasgouttes, 14 May 2018 +\end_layout + \begin_layout Subsection* screen-font-update \end_layout @@ -581,15 +634,19 @@ textstyle-apply \end_layout \begin_layout Description -Action Toggle user-defined (=last-time used) text style. +Action Apply last used text properties. \end_layout \begin_layout Description -Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. +Notion These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. \end_layout \begin_layout Description -Syntax textstyle-apply +Syntax textstyle-apply []textstyle-apply +\end_layout + +\begin_layout Description +Params : number of the selection in the internal freefonts stack to be applied. \end_layout \begin_layout Description @@ -609,7 +666,7 @@ Syntax textstyle-update \end_layout \begin_layout Description -Params : specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall. +Params : specifies font attributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall. \begin_inset Newline newline \end_inset @@ -1060,6 +1117,22 @@ Syntax branch-insert Origin vermeer, 17 Aug 2003 \end_layout +\begin_layout Subsection* +buffer-anonymize +\end_layout + +\begin_layout Description +Action For debug purposes only. Convert all [a-zA-Z0-1] characters to single character. Useful when submitting docs to list or bugzilla. +\end_layout + +\begin_layout Description +Syntax buffer-anonymize +\end_layout + +\begin_layout Description +Origin sanda, Feb 1 2018 +\end_layout + \begin_layout Subsection* buffer-begin \end_layout @@ -1261,7 +1334,7 @@ Syntax changes-output \end_layout \begin_layout Description -Origin jspitzm, 21 Jan 2005 +Origin spitz, 21 Jan 2005 \end_layout \begin_layout Subsection* @@ -1321,7 +1394,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 +1410,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* @@ -1632,26 +1713,6 @@ Action Cuts to the clipboard. Syntax cut \end_layout -\begin_layout Subsection* -date-insert -\end_layout - -\begin_layout Description -Action Inserts the current date. -\end_layout - -\begin_layout Description -Syntax date-insert [] -\end_layout - -\begin_layout Description -Params : Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function. -\end_layout - -\begin_layout Description -Origin jdblair, 31 Jan 2000 -\end_layout - \begin_layout Subsection* depth-decrement \end_layout @@ -1809,7 +1870,7 @@ Params See LFUN_DIALOG_SHOW . \end_layout \begin_layout Description -Origin JSpitzm, 30 Apr 2007 +Origin spitz, 30 Apr 2007 \end_layout \begin_layout Subsection* @@ -1892,6 +1953,22 @@ Syntax escape Origin Lgb, 17 May 2001 \end_layout +\begin_layout Subsection* +export-cancel +\end_layout + +\begin_layout Description +Action Cancel background export process. +\end_layout + +\begin_layout Description +Syntax export-cancel +\end_layout + +\begin_layout Description +Origin rgh, 10 December 2017 +\end_layout + \begin_layout Subsection* file-insert \end_layout @@ -1901,11 +1978,11 @@ Action Inserts another LyX file. \end_layout \begin_layout Description -Syntax file-insert [] +Syntax file-insert [] [ignorelang] \end_layout \begin_layout Description -Params : Filename to be inserted. +Params : Filename to be inserted. ignorelang: If given, the (main) language of the inserted file is ignored (the context language is used). \end_layout \begin_layout Subsection* @@ -2076,6 +2153,46 @@ Syntax graphics-reload Origin vfr, 10 Aug 2009 \end_layout +\begin_layout Subsection* +graphics-set-group +\end_layout + +\begin_layout Description +Action Set the group for the graphics inset on the cursor position. +\end_layout + +\begin_layout Description +Syntax graphics-set-group [] +\end_layout + +\begin_layout Description +Params : Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group. +\end_layout + +\begin_layout Description +Origin sanda, 6 May 2008 +\end_layout + +\begin_layout Subsection* +graphics-unify +\end_layout + +\begin_layout Description +Action Set the same group for all graphics insets in the marked block. +\end_layout + +\begin_layout Description +Syntax graphics-unify [] +\end_layout + +\begin_layout Description +Params : Id for an existing group. In case the Id is an empty string, the group Id from the first graphics inset will be used. +\end_layout + +\begin_layout Description +Origin sanda, 7 Feb 2018 +\end_layout + \begin_layout Subsection* href-insert \end_layout @@ -2185,7 +2302,7 @@ Syntax info-insert \end_layout \begin_layout Description -Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer +Params : date|moddate|fixdate|time|modtime|fixtime|shortcut|shortcuts|lyxrc| lyxinfo|package|textclass|menu|l7n|icon|buffer|vcs \begin_inset Newline newline \end_inset @@ -2193,37 +2310,65 @@ Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \begin_inset Newline newline \end_inset - shortcut[s]: name of lfun (e.g math-insert +date: current date (formatted and localized) +\begin_inset Newline newline +\end_inset + +moddate: date of last modification (saving) (formatted and localized) +\begin_inset Newline newline +\end_inset + +fixdate: a static date (formatted and localized) +\begin_inset Newline newline +\end_inset + +time: current time (formatted and localized) +\begin_inset Newline newline +\end_inset + +modtime: time of last modification (saving) (formatted and localized) +\begin_inset Newline newline +\end_inset + +fixtime: a static time (formatted and localized) +\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) +lyxrc: name of rc_entry (e.g. bind_file) \begin_inset Newline newline \end_inset - lyxinfo: "version" - used version of LyX +lyxinfo: "version" - used version of LyX \begin_inset Newline newline \end_inset - package: name of latex package (e.g. listings) +package: name of latex package (e.g. listings) \begin_inset Newline newline \end_inset - textclass: name of textclass (e.g. article) +textclass: name of textclass (e.g. article) \begin_inset Newline newline \end_inset - menu: name of lfun used in menu +menu: name of lfun used in menu \begin_inset Newline newline \end_inset - icon: icon of lfun used in toolbar or direct icon name +l7n: localizable string. \begin_inset Newline newline \end_inset - buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" +icon: icon of lfun used in toolbar or direct icon name +\begin_inset Newline newline +\end_inset + +buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time" \end_layout \begin_layout Description @@ -2259,7 +2404,7 @@ inset-begin \end_layout \begin_layout Description -Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise +Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset. \end_layout \begin_layout Description @@ -2275,7 +2420,7 @@ inset-begin-select \end_layout \begin_layout Description -Action Move the cursor to the beginning of the current inset if it is not already there, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). +Action Move the cursor to the beginning of the current inset if it is not already there. If the cursor is already at the beginning of the current inset, move it to the beginning of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection). \end_layout \begin_layout Description @@ -2335,7 +2480,7 @@ inset-edit \end_layout \begin_layout Description -Action Edit the inset at cursor with an external application, if one is attributed. +Action Edit the inset at cursor with an external application, if one is attributed. If the inset is file based, the referenced file is edited. Otherwise, the inset contents is written to a temporary file, the inset is locked, and the temporary file is edited. In this case, LFUN_INSET_END_EDIT must be called to overtake the changes and unlock the inset after editing is finished. \end_layout \begin_layout Description @@ -2351,7 +2496,7 @@ Currently only the filename will be considered. \end_layout \begin_layout Description -Origin JSpitzm, 27 Apr 2006 +Origin spitz, 27 Apr 2006 \end_layout \begin_layout Subsection* @@ -2359,7 +2504,7 @@ inset-end \end_layout \begin_layout Description -Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise +Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset. \end_layout \begin_layout Description @@ -2370,12 +2515,28 @@ Syntax inset-end Origin lasgouttes, 16 Mar 2009 \end_layout +\begin_layout Subsection* +inset-end-edit +\end_layout + +\begin_layout Description +Action End editing the inset at cursor with an external application. This replaces the inset contents with the contents of the temporary file, deletes the file and unlocks the inset. +\end_layout + +\begin_layout Description +Syntax inset-end-edit +\end_layout + +\begin_layout Description +Origin gb, 11 Oct 2015 +\end_layout + \begin_layout Subsection* inset-end-select \end_layout \begin_layout Description -Action Move the cursor to the end of the current inset if it is not already there, or at the end of the enclosing inset otherwise (adding the traversed text to the selection). +Action Move the cursor to the end of the current inset if it is not already there. If the cursor is already at the end of the current inset, move it to the end of the enclosing inset or the main work area, respectively, if there is no enclosing inset (adding the traversed text to the selection). \end_layout \begin_layout Description @@ -2411,7 +2572,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 @@ -2419,7 +2580,7 @@ Close all Notes (also works for a particular branch, for example): \begin_inset Newline newline \end_inset - inset-forall Note inset-toggle close +inset-forall Note inset-toggle close \begin_inset Newline newline \end_inset @@ -2427,7 +2588,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 @@ -2435,7 +2596,7 @@ 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 +inset-forall Note char-backward \end_layout \begin_layout Description @@ -2459,7 +2620,7 @@ Params : +hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script> \begin_inset Newline newline \end_inset @@ -2509,91 +2670,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. -\end_layout - -\begin_layout Description -Syntax inset-modify inset-modify changetype inset-modify tabular [] +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 -Params Generally see LFUN_INSET_INSERT for further details. -\begin_inset Newline newline -\end_inset - -In case that is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment. -\begin_inset Newline newline -\end_inset - -: append-row|append-column|delete-row|delete-column|copy-row| -\begin_inset Newline newline -\end_inset - -copy-column|move-column-right|move-column-left|move-row-down|move-row-up| -\begin_inset Newline newline -\end_inset - -toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right| -\begin_inset Newline newline -\end_inset - -align-left|align-right|align-center|align-block|align-decimal|set-decimal-point| -\begin_inset Newline newline -\end_inset - -valign-top|valign-bottom|valign-middle|longtabular-align-left| -\begin_inset Newline newline -\end_inset - -longtabular-align-center|longtabular-align-right|m-align-left|m-align-right| +Syntax inset-modify \begin_inset Newline newline \end_inset -m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn| -\begin_inset Newline newline -\end_inset +inset-modify changetype +\end_layout -set-all-lines|unset-all-lines|toggle-longtabular|set-longtabular|unset-longtabular|set-pwidth| +\begin_layout Description +Sample Change a Note inset into a Comment inset: \begin_inset Newline newline \end_inset -set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular| +inset-modify note Note Comment \begin_inset Newline newline \end_inset -set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead| +Change a Box into an Ovalbox: \begin_inset Newline newline \end_inset -unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot| +inset-modify changetype Ovalbox \begin_inset Newline newline \end_inset -set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption| +Change a quotation mark to e[nglish style], l[eft side = opening], s[ingle = inner, secondary] \begin_inset Newline newline \end_inset -set-special-column|set-special-multicolumn|set-special-multirow| +inset-modify changetype els \begin_inset Newline newline \end_inset -toggle-booktabs|set-booktabs|unset-booktabs|set-top-space|set-bottom-space| +Change only the style of a quotation mark, maintaining the other aspects (. = wildcard) \begin_inset Newline newline \end_inset -set-interline-space|set-border-lines|tabular-valign-top| +inset-modify changetype e.. \begin_inset Newline newline \end_inset -tabular-valign-middle|tabular-valign-bottom|set-tabular-width : additional argument for some commands, use debug mode to explore its values. -\end_layout - -\begin_layout Description -Sample inset-modify note Note Comment -\begin_inset Newline newline -\end_inset - inset-modify changetype Ovalbox \end_layout \begin_layout Subsection* @@ -2705,7 +2826,7 @@ Params : tone-falling, tone-rising, tone-high-rising, tone-low-rising, ton \end_layout \begin_layout Description -Origin JSpitzm, 22 Aug 2012 +Origin spitz, 22 Aug 2012 \end_layout \begin_layout Subsection* @@ -3013,7 +3134,7 @@ Params : default: newline \end_layout \begin_layout Description -Origin JSpitzm, 25 Mar 2008 +Origin spitz, 25 Mar 2008 \end_layout \begin_layout Subsection* @@ -3193,11 +3314,15 @@ Notion Removes the selection. \end_layout \begin_layout Description -Syntax paragraph-break [] +Syntax paragraph-break [] [ignoresep] \end_layout \begin_layout Description Params : "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line. +\begin_inset Newline newline +\end_inset + +ignoresep: Do not account for paragraph separators while breaking. \end_layout \begin_layout Subsection* @@ -3237,27 +3362,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 +Syntax paragraph-goto [ ] \end_layout \begin_layout Description -Params : paragraph id +Params : paragraph id \begin_inset Newline newline \end_inset -: desired position within the paragraph +: 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* @@ -3372,6 +3497,26 @@ Params For parameters see LFUN_PARAGRAPH_PARAMS Origin leeming, 30 Mar 2004 \end_layout +\begin_layout Subsection* +paragraph-select +\end_layout + +\begin_layout Description +Action Move cursor to beginning of current paragraph and select to the end in downward direction +\end_layout + +\begin_layout Description +Notion This function is by default bound to triple mouse click +\end_layout + +\begin_layout Description +Syntax paragraph-select +\end_layout + +\begin_layout Description +Origin Kornel, 16 Apr 2019 +\end_layout + \begin_layout Subsection* paragraph-up \end_layout @@ -3489,40 +3634,108 @@ 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 [] +Syntax quote-insert [] [] [