From 45f3616786b8ce144f34cbc3827db190736c45f0 Mon Sep 17 00:00:00 2001 From: Scott Kostyshak Date: Sun, 28 Jan 2018 21:41:52 -0500 Subject: [PATCH] Update docs to 2.3.0rc2 format --- lib/doc/LFUNs.lyx | 1117 +++++++++++++-------------------------------- 1 file changed, 323 insertions(+), 794 deletions(-) diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index 9d3ce9147a..4c5bb2ea77 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -37,8 +37,7 @@ End \font_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 @@ -68,7 +67,6 @@ End \suppress_date false \justification true \use_refstyle 0 -\use_minted 0 \index Index \shortcut idx \color #008000 @@ -84,7 +82,6 @@ End \is_math_indent 0 \math_numbering_side default \quotes_style english -\dynamic_quotes 0 \papercolumns 1 \papersides 1 \paperpagestyle default @@ -93,6 +90,7 @@ End \html_math_output 0 \html_css_as_file 0 \html_be_strict false +\use_minted 0 \end_header \begin_body @@ -124,8 +122,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 +169,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 In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout. \end_layout \begin_layout Description @@ -192,18 +189,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 (is 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 @@ -531,11 +525,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 @@ -595,8 +585,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 +601,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* @@ -625,8 +613,7 @@ Action Toggle user-defined (=last-time used) text style. \end_layout \begin_layout Description -Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically - triggered when using Text Style dialog. +Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog. \end_layout \begin_layout Description @@ -642,8 +629,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 +637,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 atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall. \begin_inset Newline newline \end_inset @@ -901,8 +885,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 +941,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 +961,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 +993,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 +1033,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 @@ -1132,8 +1105,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 +1129,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 +1185,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 +1217,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 +1233,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 +1265,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 @@ -1322,7 +1289,7 @@ Syntax changes-output \end_layout \begin_layout Description -Origin spitz, 21 Jan 2005 +Origin jspitzm, 21 Jan 2005 \end_layout \begin_layout Subsection* @@ -1350,10 +1317,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 +1329,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,8 +1345,7 @@ 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 @@ -1399,8 +1361,7 @@ 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 @@ -1420,10 +1381,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 +1393,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 +1413,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 +1425,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 +1445,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 +1457,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 @@ -1571,18 +1513,11 @@ 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 +1525,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 +1537,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 +1545,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 +1553,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 @@ -1755,9 +1681,7 @@ 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. +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 @@ -1769,8 +1693,7 @@ 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 +1705,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 +1737,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 +1757,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 @@ -1853,8 +1773,7 @@ compare|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 +1793,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 +1805,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 @@ -1929,7 +1845,7 @@ Params See LFUN_DIALOG_SHOW . \end_layout \begin_layout Description -Origin spitz, 30 Apr 2007 +Origin JSpitzm, 30 Apr 2007 \end_layout \begin_layout Subsection* @@ -1973,8 +1889,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 +1917,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 @@ -2015,22 +1928,6 @@ 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 @@ -2072,8 +1969,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 +1993,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 +2009,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 +2029,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 +2049,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 +2073,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 @@ -2255,8 +2141,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 +2169,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,8 +2189,7 @@ 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 @@ -2318,8 +2201,7 @@ 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 +2209,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 @@ -2346,46 +2225,41 @@ Params : shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|icon|buffer \begin_inset Newline newline \end_inset -: argument for a given type. - Look into InsetInfo.h for detailed description. +: argument for a given type. Look into InsetInfo.h for detailed description. \begin_inset Newline newline \end_inset -shortcut[s]: name of lfun (e.g math-insert + 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 + 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"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time" \end_layout \begin_layout Description @@ -2405,10 +2279,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 +2295,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, or at the beginning of the enclosing inset otherwise \end_layout \begin_layout Description @@ -2441,9 +2311,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, or at the beginning of the enclosing inset otherwise (adding the traversed text to the selection). \end_layout \begin_layout Description @@ -2463,8 +2331,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 +2355,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 +2371,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. \end_layout \begin_layout Description @@ -2525,7 +2387,7 @@ Currently only the filename will be considered. \end_layout \begin_layout Description -Origin spitz, 27 Apr 2006 +Origin JSpitzm, 27 Apr 2006 \end_layout \begin_layout Subsection* @@ -2533,8 +2395,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, or at the end of the enclosing inset otherwise \end_layout \begin_layout Description @@ -2550,9 +2411,7 @@ 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, or at the end of the enclosing inset otherwise (adding the traversed text to the selection). \end_layout \begin_layout Description @@ -2572,15 +2431,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 +2439,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,7 +2447,7 @@ Sample Remove all index insets: \begin_inset Newline newline \end_inset -inset-forall Index char-delete-forward force + inset-forall Index char-delete-forward force \begin_inset Newline newline \end_inset @@ -2607,7 +2455,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 @@ -2615,7 +2463,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 @@ -2623,7 +2471,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 @@ -2647,12 +2495,11 @@ Params : + 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 +2509,7 @@ end_inset \begin_inset Newline newline \end_inset -where