X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fdoc%2FLFUNs.lyx;h=10834f1300b2055373a241c84eb51ef108b1f2e1;hb=cb32a61e947afcb4b53faf283a0fba9f3056c88a;hp=9d3ce9147ad104ff5f46c31cdea276a9c009466f;hpb=2860266e308e919efcf0df5d2a76e268ef3569ba;p=lyx.git diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index 9d3ce9147a..10834f1300 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -1,5 +1,5 @@ -#LyX 2.3 created this file. For more info see http://www.lyx.org/ -\lyxformat 544 +#LyX 2.4 created this file. For more info see https://www.lyx.org/ +\lyxformat 614 \begin_document \begin_header \save_transient_properties true @@ -16,7 +16,7 @@ } \end_preamble \use_default_options false -\maintain_unincluded_children false +\maintain_unincluded_children no \begin_local_layout Style Description LabelIndent MM @@ -25,8 +25,8 @@ End \end_local_layout \language english \language_package default -\inputencoding auto -\fontencoding global +\inputencoding auto-legacy +\fontencoding auto \font_roman "default" "default" \font_sans "default" "default" \font_typewriter "default" "default" @@ -34,11 +34,12 @@ End \font_default_family default \use_non_tex_fonts false \font_sc false -\font_osf false +\font_sans_osf false +\font_typewriter_osf false +\font_roman_osf false \font_sf_scale 100 100 \font_tt_scale 100 100 -\use_microtype false -\use_dash_ligatures true +\use_microtype 0 \graphics default \default_output_format default \output_sync 0 @@ -69,6 +70,7 @@ End \justification true \use_refstyle 0 \use_minted 0 +\use_lineno 0 \index Index \shortcut idx \color #008000 @@ -84,11 +86,11 @@ End \is_math_indent 0 \math_numbering_side default \quotes_style english -\dynamic_quotes 0 \papercolumns 1 \papersides 1 \paperpagestyle default \tracking_changes false +\postpone_fragile_content false \output_changes false \html_math_output 0 \html_css_as_file 0 @@ -124,8 +126,8 @@ LyX Functions These are commands that are used to make \SpecialChar LyX perform specific actions. \SpecialChar LyX - itself uses these functions internally, and every internal action is bound - to an LFUN. + itself uses these functions internally, and every internal action is + bound to an LFUN. \end_layout \begin_layout Standard @@ -171,8 +173,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 @@ -192,18 +193,15 @@ 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 (is there is one). +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. +before: If this is given, the new environment will be appended rather than prepended. \end_layout \begin_layout Description @@ -306,6 +304,22 @@ Syntax font-ital 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 @@ -455,7 +469,7 @@ Action Sets the layout (that is, environment) for the current paragraph. \end_layout \begin_layout Description -Syntax layout [ignorenests] +Syntax layout [ignoreautonests] \end_layout \begin_layout Description @@ -463,7 +477,7 @@ Params : the layout to use \begin_inset Newline newline \end_inset -ignorenests: If specified, nesting advices will be ignored. +ignoreautonests: If specified, nesting advices will be ignored. \end_layout \begin_layout Subsection* @@ -531,11 +545,7 @@ Action Reloads layout information. \end_layout \begin_layout Description -Notion Reloads all layout information for the current buffer from disk, - thus recognizing any changes that have been made to layout files on the - fly. - This is intended to be used only by layout developers and should not be - used when one is trying to do actual work. +Notion Reloads all layout information for the current buffer from disk, thus recognizing any changes that have been made to layout files on the fly. This is intended to be used only by layout developers and should not be used when one is trying to do actual work. \end_layout \begin_layout Description @@ -562,6 +572,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 [ignoreautonests] +\end_layout + +\begin_layout Description +Params : the layout to toggle +\begin_inset Newline newline +\end_inset + +ignoreautonests: 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 @@ -595,8 +633,7 @@ Syntax textclass-apply \end_layout \begin_layout Description -Params : the textclass to set. - Note that this must be the filename, minus the ".layout" extension. +Params : the textclass to set. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* @@ -612,8 +649,7 @@ Syntax textclass-load \end_layout \begin_layout Description -Params : the textclass to load. - Note that this must be the filename, minus the ".layout" extension. +Params : the textclass to load. Note that this must be the filename, minus the ".layout" extension. \end_layout \begin_layout Subsection* @@ -621,16 +657,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 These properties are stored via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. \end_layout \begin_layout Description -Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically - triggered when using Text Style dialog. +Syntax textstyle-apply []textstyle-apply \end_layout \begin_layout Description -Syntax textstyle-apply +Params : number of the selection in the internal freefonts stack to be applied. \end_layout \begin_layout Description @@ -642,8 +681,7 @@ textstyle-update \end_layout \begin_layout Description -Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP -LY. +Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY. \end_layout \begin_layout Description @@ -651,9 +689,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 @@ -901,8 +937,7 @@ Action Rejects all tracked changes in the document. \end_layout \begin_layout Description -Notion Reject does not work recursively; the user may have to repeat the - operation. +Notion Reject does not work recursively; the user may have to repeat the operation. \end_layout \begin_layout Description @@ -958,8 +993,7 @@ Action Adds database, which will be used for bibtex citations. \end_layout \begin_layout Description -Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX - bibliography) found from the cursor position. +Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout \begin_layout Description @@ -979,8 +1013,7 @@ Action Adds database, which will be used for bibtex citations. \end_layout \begin_layout Description -Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe -X bibliography) found from the cursor position. +Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position. \end_layout \begin_layout Description @@ -1012,29 +1045,23 @@ bookmark-goto \end_layout \begin_layout Description -Action Moves the cursor to the numbered bookmark, opening the file if necessary. - Note that bookmarks are saved per-session, not per file. +Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file. \end_layout \begin_layout Description -Notion Bookmark 0 has a special purpose. - It is automatically set +Notion Bookmark 0 has a special purpose. It is automatically set \begin_inset Newline newline \end_inset -1. - to the paragraph you are currently editing +1. to the paragraph you are currently editing \begin_inset Newline newline \end_inset -2. - to the paragraph from where you are jumping to the last-edited position - (jump-back feature) +2. to the paragraph from where you are jumping to the last-edited position (jump-back feature) \begin_inset Newline newline \end_inset -3. - when jumping from crossreference to the requested label by LFUN_LABEL_GOTO. +3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO. \end_layout \begin_layout Description @@ -1058,9 +1085,7 @@ Action Save a bookmark. \end_layout \begin_layout Description -Notion Saves a numbered bookmark to the sessions file. - The number must be between 1 and 9, inclusive. - Note that bookmarks are saved per-session, not per file. +Notion Saves a numbered bookmark to the sessions file. The number must be between 1 and 9, inclusive. Note that bookmarks are saved per-session, not per file. \end_layout \begin_layout Description @@ -1115,6 +1140,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 @@ -1132,8 +1173,7 @@ buffer-begin-select \end_layout \begin_layout Description -Action Move the cursor to the beginning of the document adding the traversed - text to the selection. +Action Move the cursor to the beginning of the document adding the traversed text to the selection. \end_layout \begin_layout Description @@ -1157,8 +1197,7 @@ buffer-end-select \end_layout \begin_layout Description -Action Move the cursor to the end of the document adding the traversed text - to the selection. +Action Move the cursor to the end of the document adding the traversed text to the selection. \end_layout \begin_layout Description @@ -1214,8 +1253,7 @@ cell-split \end_layout \begin_layout Description -Action Splits cell and shifts right part to the next cell (inside the math - grid). +Action Splits cell and shifts right part to the next cell (inside the math grid). \end_layout \begin_layout Description @@ -1247,8 +1285,7 @@ change-next \end_layout \begin_layout Description -Action Moves the cursor to the position of the next change of the change - tracking records. +Action Moves the cursor to the position of the next change of the change tracking records. \end_layout \begin_layout Description @@ -1264,8 +1301,7 @@ change-previous \end_layout \begin_layout Description -Action Moves the cursor to the position of the previous change of the change - tracking records. +Action Moves the cursor to the position of the previous change of the change tracking records. \end_layout \begin_layout Description @@ -1297,8 +1333,7 @@ changes-merge \end_layout \begin_layout Description -Action Open change tracking dialog for merging and moves the cursor to the - position of the next change. +Action Open change tracking dialog for merging and moves the cursor to the position of the next change. \end_layout \begin_layout Description @@ -1350,10 +1385,7 @@ Action Moves the cursor one position logically backwards. \end_layout \begin_layout Description -Notion This is not the action which should be bound to the arrow keys, because - backwards may be left or right, depending on the language. - The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, - which in turn may employ this one. +Notion This is not the action which should be bound to the arrow keys, because backwards may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one. \end_layout \begin_layout Description @@ -1365,8 +1397,7 @@ char-backward-select \end_layout \begin_layout Description -Action Moves the cursor one position logically backwards, adding traversed - position to the selection. +Action Moves the cursor one position logically backwards, adding traversed position to the selection. \end_layout \begin_layout Description @@ -1382,16 +1413,15 @@ char-delete-backward \end_layout \begin_layout Description -Action Deletes one character in the backward direction (usually the "BackSpace" - key). +Action Deletes one character in the backward direction (usually the "BackSpace" key). \end_layout \begin_layout Description -Syntax char-delete-backward [force] +Syntax char-delete-backward [confirm] \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* @@ -1399,16 +1429,15 @@ char-delete-forward \end_layout \begin_layout Description -Action Deletes one character in the backward direction (usually the "Delete" - key). +Action Deletes one character in the backward direction (usually the "Delete" key). \end_layout \begin_layout Description -Syntax char-delete-forward [force] +Syntax char-delete-forward [confirm] \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* @@ -1420,10 +1449,7 @@ Action Moves the cursor one position logically forward. \end_layout \begin_layout Description -Notion This is not the action which should be bound to the arrow keys, because - forward may be left or right, depending on the language. - The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, - which in turn may employ this one. +Notion This is not the action which should be bound to the arrow keys, because forward may be left or right, depending on the language. The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions, which in turn may employ this one. \end_layout \begin_layout Description @@ -1435,8 +1461,7 @@ char-forward-select \end_layout \begin_layout Description -Action Moves the cursor one position logically forward, adding traversed - position to the selection. +Action Moves the cursor one position logically forward, adding traversed position to the selection. \end_layout \begin_layout Description @@ -1456,13 +1481,7 @@ Action Moves the cursor one position "to the left". \end_layout \begin_layout Description -Notion This is the action which should be taken when the "left" key is pressed. - Generally, it moves the cursor one position to the left. - However, in Bidi text this become slightly more complicated, and there - are different modes of cursor movement. - In "visual mode", this moves left, plain and simple. - In "logical mode", movement is logically forward in RTL paragraphs, and - logically backwards in LTR paragraphs. +Notion This is the action which should be taken when the "left" key is pressed. Generally, it moves the cursor one position to the left. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves left, plain and simple. In "logical mode", movement is logically forward in RTL paragraphs, and logically backwards in LTR paragraphs. \end_layout \begin_layout Description @@ -1474,8 +1493,7 @@ char-left-select \end_layout \begin_layout Description -Action Moves the cursor one position "to the left", adding traversed position - to the selection. +Action Moves the cursor one position "to the left", adding traversed position to the selection. \end_layout \begin_layout Description @@ -1495,14 +1513,7 @@ Action Moves the cursor one position "to the right". \end_layout \begin_layout Description -Notion This is the action which should be taken when the "right" key is - pressed. - Generally, it moves the cursor one position to the right. - However, in Bidi text this become slightly more complicated, and there - are different modes of cursor movement. - In "visual mode", this moves right, plain and simple. - In "logical mode", movement is logically forward in LTR paragraphs, and - logically backwards in RTL paragraphs. +Notion This is the action which should be taken when the "right" key is pressed. Generally, it moves the cursor one position to the right. However, in Bidi text this become slightly more complicated, and there are different modes of cursor movement. In "visual mode", this moves right, plain and simple. In "logical mode", movement is logically forward in LTR paragraphs, and logically backwards in RTL paragraphs. \end_layout \begin_layout Description @@ -1514,8 +1525,7 @@ char-right-select \end_layout \begin_layout Description -Action Moves the cursor one position "to the right", adding traversed position - to the selection. +Action Moves the cursor one position "to the right", adding traversed position to the selection. \end_layout \begin_layout Description @@ -1566,23 +1576,48 @@ Params : Citation (shortcut listed in available citations). Origin AAS, 97-02-23 \end_layout +\begin_layout Subsection* +citation-open +\end_layout + +\begin_layout Description +Action Opens the corresponding pdf/url for a given citation inset. +\end_layout + +\begin_layout Description +Syntax citation-open [EXTERNAL] TARGET +\end_layout + +\begin_layout Description +Params : URL (https:,file:) of the document. +\begin_inset Newline newline +\end_inset + +: Use external executable script for finding target +\begin_inset Newline newline +\end_inset + + and launching viewer. In this case TARGET consists of author and year +\begin_inset Newline newline +\end_inset + + and will be passed as an input argument to the script. +\end_layout + +\begin_layout Description +Origin Sanda, 16 Aug 2020 +\end_layout + \begin_layout Subsection* clipboard-paste \end_layout \begin_layout Description -Action Pastes text from the active clipboard (retains formatting if the - clipboard contains formatted text). - Pastes plain text if plain text is on the clipboard, but tries to interpret - it in special ways for certain insets, e.g. - converting csv data to rows and columns if the paste happens in a tabular - inset. +Action Pastes text from the active clipboard (retains formatting if the clipboard contains formatted text). Pastes plain text if plain text is on the clipboard, but tries to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. \end_layout \begin_layout Description -Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart - of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source - is the clipboard, not the selection. +Notion Historically, LFUN_CLIPBOARD_PASTE was introduced as a counterpart of LFUN_PRIMARY_SELECTION_PASTE: It behaved exactly the same, but the source is the clipboard, not the selection. \end_layout \begin_layout Description @@ -1590,8 +1625,7 @@ Syntax clipboard-paste [] \end_layout \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. - "Join lines". +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout \begin_layout Description @@ -1603,12 +1637,7 @@ clipboard-paste-simple \end_layout \begin_layout Description -Action Pastes plain text from the active clipboard even if formatted LyX - content is in the clipboard. - Pastes plain text if plain text is on the clipboard, without trying to - interpret it in special ways for certain insets, e.g. - converting csv data to rows and columns if the paste happens in a tabular - inset. +Action Pastes plain text from the active clipboard even if formatted LyX content is in the clipboard. Pastes plain text if plain text is on the clipboard, without trying to interpret it in special ways for certain insets, e.g. converting csv data to rows and columns if the paste happens in a tabular inset. \end_layout \begin_layout Description @@ -1616,8 +1645,7 @@ Syntax clipboard-paste-simple [] \end_layout \begin_layout Description -Params : "paragraph" will cause pasting as one paragraph, i.e. - "Join lines". +Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines". \end_layout \begin_layout Subsection* @@ -1625,9 +1653,7 @@ command-execute \end_layout \begin_layout Description -Action Switches the focus to the minibuffer so that the user can type in - there. - If necessary, it opens the minibuffer toolbar. +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 @@ -1742,35 +1768,12 @@ 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 \begin_layout Description -Action Decrease the nesting depth of the (selected) paragraph(s) inside - lists. +Action Decrease the nesting depth of the (selected) paragraph(s) inside lists. \end_layout \begin_layout Description @@ -1782,8 +1785,7 @@ depth-increment \end_layout \begin_layout Description -Action Increase the nesting depth of the (selected) paragraph(s) inside - lists. +Action Increase the nesting depth of the (selected) paragraph(s) inside lists. \end_layout \begin_layout Description @@ -1815,8 +1817,7 @@ dialog-hide \end_layout \begin_layout Description -Action Hides showed dialog. - Counterpart to LFUN_DIALOG_SHOW . +Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW . \end_layout \begin_layout Description @@ -1836,8 +1837,7 @@ dialog-show \end_layout \begin_layout Description -Action Shows hidden dialog or creates new one for a given function/inset - settings etc. +Action Shows hidden dialog or creates new one for a given function/inset settings etc. \end_layout \begin_layout Description @@ -1849,12 +1849,11 @@ Params : aboutlyx|bibitem|bibtex|box|branch|changes|character|citation| \begin_inset Newline newline \end_inset -compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float| +compare|counter|document|errorlist|ert|external|file|findreplace|findreplaceadv|float| \begin_inset Newline newline \end_inset -graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimit -er| +graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter| \begin_inset Newline newline \end_inset @@ -1874,8 +1873,7 @@ thesaurus|texinfo|toc|view-source|vspace|wrap| \begin_inset Newline newline \end_inset -: data, usually settings for the given dialog. - Use debug mode for the details. +: data, usually settings for the given dialog. Use debug mode for the details. \end_layout \begin_layout Description @@ -1887,13 +1885,11 @@ dialog-show-new-inset \end_layout \begin_layout Description -Action Shows hidden dialog or create new one for a given inset settings - etc. +Action Shows hidden dialog or create new one for a given inset settings etc. \end_layout \begin_layout Description -Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given - inset. +Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset. \end_layout \begin_layout Description @@ -1973,8 +1969,7 @@ down-select \end_layout \begin_layout Description -Action Moves the cursor one line in downward direction adding the current - position to the selection. +Action Moves the cursor one line in downward direction adding the current position to the selection. \end_layout \begin_layout Description @@ -2002,9 +1997,7 @@ escape \end_layout \begin_layout Description -Action Clears the selection. - If no text is selected call LFUN_FINISHED_FORWARD. - Inside math mode jumps out of the math inset. +Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset. \end_layout \begin_layout Description @@ -2040,11 +2033,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* @@ -2072,8 +2065,7 @@ file-insert-plaintext-para \end_layout \begin_layout Description -Action Inserts plain text file as paragraph (i.e. - join lines). +Action Inserts plain text file as paragraph (i.e. join lines). \end_layout \begin_layout Description @@ -2097,15 +2089,11 @@ Action Inserts CharStyle, Custom inset or XML short element. \end_layout \begin_layout Description -Notion Look into the Customization manual for more information about these - elements. +Notion Look into the Customization manual for more information about these elements. \begin_inset Newline newline \end_inset -To make this command enabled the layout file for the document class you're - using has to load the character styles. - There are a few contained in the Logical Markup module. - You can also of course create some yourself. +To make this command enabled the layout file for the document class you're using has to load the character styles. There are a few contained in the Logical Markup module. You can also of course create some yourself. \begin_inset Newline newline \end_inset @@ -2117,10 +2105,7 @@ Syntax flex-insert Name \end_layout \begin_layout Description -Params Name: This name must be defined either in your layout file or imported - by some module. - The definition is InsetLayout Name or InsetLayout . - The Flex: prefix is optional. +Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout . The Flex: prefix is optional. \end_layout \begin_layout Description @@ -2140,8 +2125,7 @@ Syntax float-insert \end_layout \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout \begin_layout Description @@ -2161,8 +2145,7 @@ Syntax float-list-insert \end_layout \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout \begin_layout Description @@ -2186,8 +2169,7 @@ Syntax float-wide-insert \end_layout \begin_layout Description -Params : type of float depends on the used textclass. - Usually "algorithm", "table", "figure" parameters can be given. +Params : type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given. \end_layout \begin_layout Description @@ -2226,6 +2208,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 @@ -2255,8 +2277,7 @@ Action Only active in IPA inset. \end_layout \begin_layout Description -Notion Dummy function which is only active in a IPA inset. - It's used to toggle the IPA toolbar if the cursor moves into an IPA inset. +Notion Dummy function which is only active in a IPA inset. It's used to toggle the IPA toolbar if the cursor moves into an IPA inset. \end_layout \begin_layout Description @@ -2284,8 +2305,7 @@ Syntax index-insert [] \end_layout \begin_layout Description -Params : name of the index, if multiple indices are defined. - With an empty argument, the default index is selected. +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout \begin_layout Description @@ -2305,21 +2325,59 @@ Syntax index-print [] \end_layout \begin_layout Description -Params : name of the index, if multiple indices are defined. - With an empty argument, the default index is selected. +Params : name of the index, if multiple indices are defined. With an empty argument, the default index is selected. \end_layout \begin_layout Description 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 +\end_layout + +\begin_layout Description +Params : 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 Description -Action Displays shortcuts, lyxrc, package and textclass availability and - menu information in a non-editable boxed InsetText. +Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText. \end_layout \begin_layout Description @@ -2327,14 +2385,11 @@ Notion Apart from lfun arguments you can use the following method: \begin_inset Newline newline \end_inset -1. - input the type and argument of this inset, e.g. - "menu paste", in the work area. +1. input the type and argument of this inset, e.g. "menu paste", in the work area. \begin_inset Newline newline \end_inset -2. - select the text and run info-insert lfun. +2. select the text and run info-insert lfun. \end_layout \begin_layout Description @@ -2342,12 +2397,35 @@ Syntax info-insert \end_layout \begin_layout Description -Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|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 + +: argument for a given type. Look into InsetInfo.h for detailed description. +\begin_inset Newline newline +\end_inset + +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 -: argument for a given type. - Look into InsetInfo.h for detailed description. +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 @@ -2357,8 +2435,7 @@ 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 @@ -2366,13 +2443,11 @@ 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 @@ -2380,12 +2455,15 @@ menu: name of lfun used in menu \begin_inset Newline newline \end_inset +l7n: localizable string. +\begin_inset Newline newline +\end_inset + icon: icon of lfun used in toolbar or direct icon name \begin_inset Newline newline \end_inset -buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|" -vcs-date"|"vcs-time" +buffer: "name"|"name-noext"|"path"|"class" vcs: "tree-revision"|"revision"|"author"|"date"|"time" \end_layout \begin_layout Description @@ -2405,10 +2483,7 @@ Action Apply data for an inset. \end_layout \begin_layout Description -Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be - applied. - This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending - on the context where it is called. +Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be applied. This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending on the context where it is called. \end_layout \begin_layout Description @@ -2424,8 +2499,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 @@ -2441,9 +2515,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 @@ -2463,8 +2535,7 @@ Action Copies the inset to the clipboard as a certain type. \end_layout \begin_layout Description -Notion Currently used only for InsetInfo where its content is copied as - a text. +Notion Currently used only for InsetInfo where its content is copied as a text. \end_layout \begin_layout Description @@ -2488,11 +2559,7 @@ Syntax inset-dissolve [] \end_layout \begin_layout Description -Params : this can be used to make sure the right kind of inset is - dissolved. - For example "dissolve" entry in the charstyles sub-menu should only dissolve - the charstyle inset, even if the cursor is inside several nested insets - of different type. +Params : this can be used to make sure the right kind of inset is dissolved. For example "dissolve" entry in the charstyles sub-menu should only dissolve the charstyle inset, even if the cursor is inside several nested insets of different type. \begin_inset Newline newline \end_inset @@ -2508,8 +2575,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 @@ -2533,8 +2599,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 @@ -2545,14 +2610,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 @@ -2572,15 +2651,7 @@ 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 100000. - Note also that inset-forall does not update metrics between iterations, - which can lead to bugs. - This has to be eventually fixed. +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 100000. Note also that inset-forall does not update metrics between iterations, which can lead to bugs. This has to be eventually fixed. \end_layout \begin_layout Description @@ -2588,10 +2659,7 @@ Syntax inset-forall \begin_inset Newline newline \end_inset -: Type of Inset. - If 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. +: Type of Inset. If 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 @@ -2599,11 +2667,11 @@ Sample Remove all index insets: \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 -Close all Notes (also works for a particular branch, for example): +Close all Notes: \begin_inset Newline newline \end_inset @@ -2611,6 +2679,14 @@ inset-forall Note inset-toggle close \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 @@ -2651,8 +2727,7 @@ hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script> \begin_inset Newline newline \end_inset -: depends on the given inset. - Use "lyx -dbg action" to explore. +: depends on the given inset. Use "lyx -dbg action" to explore. \end_layout \begin_layout Description @@ -2662,8 +2737,7 @@ end_inset \begin_inset Newline newline \end_inset -where