From f1531b2f90ef0f4f50cb9e9964fb1ad53df8c53c Mon Sep 17 00:00:00 2001 From: Juergen Spitzmueller Date: Thu, 13 Feb 2014 09:55:40 +0100 Subject: [PATCH] LFUNs.lyx improvements --- development/tools/gen_lfuns.py | 139 +- lib/doc/LFUNs.lyx | 5947 ++++++++++++++++---------------- 2 files changed, 3030 insertions(+), 3056 deletions(-) diff --git a/development/tools/gen_lfuns.py b/development/tools/gen_lfuns.py index c855b46cc4..e65fc439e0 100755 --- a/development/tools/gen_lfuns.py +++ b/development/tools/gen_lfuns.py @@ -12,8 +12,7 @@ # Usage: # gen_lfuns.py -import sys -import os.path +import sys,re,os.path from datetime import date def error(message): @@ -24,7 +23,7 @@ def usage(prog_name): return "Usage: %s []" % prog_name DOXYGEN_START = "/*!" -DOXYGEN_END = "*/" +DOXYGEN_END = "}," LYX_NEWLINE = "\n\\begin_inset Newline newline\n\\end_inset\n\n" LYX_BACKSLASH = "\n\\backslash\n" @@ -139,26 +138,59 @@ The LyX Team \\begin_layout Date""" + "\n" + str(date.today()) + """ \\end_layout -\\begin_layout Standard -\\begin_inset ERT -status collapsed - -\\begin_layout Plain Layout - - -\\backslash -thispagestyle{empty} -\\end_layout - -\\end_inset - - -\\begin_inset VSpace 1cm -\\end_inset - - -\\end_layout """ + +LFUNS_INTRO ="""\\begin_layout Section* +About this manual +\\end_layout + +\\begin_layout Standard +This manual documents the +\\begin_inset Quotes eld +\\end_inset + +LyX Functions +\\begin_inset Quotes erd +\\end_inset + + (abbreviated LFUNs). + These are commands that are used to make LyX perform specific actions. + LyX itself uses these functions internally, and every internal action is + bound to an LFUN. +\\end_layout + +\\begin_layout Standard +LFUNs are also used in the files that define keyboard shortcuts, menu or + toolbar items. + So if you want to change\\SpecialChar \\slash{} +customize the user interface, you need to deal + with LFUNs. + Furthermore, external programs can use LFUNs to communicate with and +\\begin_inset Quotes eld +\\end_inset + +remote-control +\\begin_inset Quotes erd +\\end_inset + + LyX. + Finally, you can also issue LFUNs directly via the so called mini-buffer + which can be opened via +\\begin_inset Info +type "shortcuts" +arg "command-execute" +\\end_inset + +. +\\end_layout + +\\begin_layout Standard +In the following, all LFUNs are listed, categorized by function. +\\end_layout + +""" + + LFUNS_FOOTER = """\\end_body \\end_document """ @@ -166,7 +198,7 @@ LFUNS_FOOTER = """\\end_body def parse_lfun(str): """Takes a comment block (str) and parses it for fields describing the LFUN. Returns a dict containing the fields.""" - lfun = dict(name="", action="", notion="", syntax="", params="", sample="", origin="") + lfun = dict(action="", notion="", syntax="", params="", sample="", origin="") field = "" lines = str.splitlines() # strip leading whitespace and * from the lines of the comment to get @@ -181,11 +213,7 @@ def parse_lfun(str): # nothing as an existing field is being added to # if a field id is found, then its the first line of the field so set the pre_space to "" # so that the first line isn't prespaced - if lines[i].startswith(LFUN_NAME_ID): - field = "name" - pre_space = "" - skip = len(ID_DICT[field]) - elif lines[i].startswith(LFUN_ACTION_ID): + if lines[i].startswith(LFUN_ACTION_ID): field = "action" pre_space = "" skip = len(ID_DICT[field]) @@ -320,7 +348,27 @@ def write_fields(file, lfun): file.write("Origin " + lfun["origin"] + "\n") file.write("\\end_layout\n") #file.write("\n") - file.write("\n") + file.write("\n") + +def write_sections(file,lfuns): + """Write sections of LFUNs""" + sections = ["Layout", "Edit", "Math", "Buffer", "System", "Hidden"] + section_headings = { + "Layout": "Layout Functions (Font, Layout and Textclass related)", + "Edit": "Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.)", + "Math": "Math Editor Functions", + "Buffer": "Buffer Fuctions (File and Window related)", + "System": "System Funtions (Preferences, LyX Server etc.)", + "Hidden": "Hidden Functions (not listed for configuration)" + } + # write the lfuns to the file + for val in sections: + file.write("\\begin_layout Section\n") + file.write(section_headings[val] + "\n") + file.write("\\end_layout\n") + for lf in lfuns: + if lf["type"] == val: + write_fields(file, lf) def main(argv): # parse command line arguments @@ -346,12 +394,15 @@ def main(argv): sys.stderr.write(script_name + ": Start processing " + argv[1] + '\n') # Read the input file and write the output file lyxaction_file = open(lyxaction_path, 'rb') - + lyxaction_text = lyxaction_file.read() - + lfuns_file.write(LFUNS_HEADER) - - # seek to the important bit of LyXAction.cpp + + # An introductory section + lfuns_file.write(LFUNS_INTRO) + + # seek to the important bit of LyXAction.cpp try: start = lyxaction_text.index("ev_item const items[] = {") except ValueError: @@ -367,12 +418,23 @@ def main(argv): # look for a doxygen comment start = lyxaction_text.find(DOXYGEN_START, start) end = lyxaction_text.find(DOXYGEN_END, start) + len(DOXYGEN_END) + name = "" + atype = "" + snippet = lyxaction_text[start:end] + defline = snippet.replace("\n", "") + match = re.match(r'.*\s*\{\s*(.+),\s*"(.*)",\s*([\w\|\s]+),\s*(\w+)\s*\},.*$', defline) + if match: + name = match.group(2) + atype = match.group(4) # parse the lfun if it is found if start > 0: - count = count + 1 - lfun = parse_lfun(lyxaction_text[start:end]) - # save the lfun (we sort it before writing) - lfun_list_unsorted.append(lfun) + if name: + count = count + 1 + lfun = parse_lfun(snippet) + lfun["name"] = name + lfun["type"] = atype + # save the lfun (we sort it before writing) + lfun_list_unsorted.append(lfun) # get the next one start = end else: @@ -382,8 +444,7 @@ def main(argv): lfun_list = sorted(lfun_list_unsorted, key=lambda k: k['name']) # write the lfuns to the file - for lf in lfun_list: - write_fields(lfuns_file, lf) + write_sections(lfuns_file, lfun_list) sys.stderr.write(script_name + ": Created documentation for " + str(count) + " LFUNs\n") diff --git a/lib/doc/LFUNs.lyx b/lib/doc/LFUNs.lyx index f271dd473d..e0b40673ad 100644 --- a/lib/doc/LFUNs.lyx +++ b/lib/doc/LFUNs.lyx @@ -92,30 +92,441 @@ The LyX Team \end_layout \begin_layout Date -2014-02-10 +2014-02-13 +\end_layout + +\begin_layout Section* +About this manual \end_layout \begin_layout Standard -\begin_inset ERT -status collapsed +This manual documents the +\begin_inset Quotes eld +\end_inset -\begin_layout Plain Layout +LyX Functions +\begin_inset Quotes erd +\end_inset - -\backslash -thispagestyle{empty} + (abbreviated LFUNs). + These are commands that are used to make LyX perform specific actions. + LyX itself uses these functions internally, and every internal action is + bound to an LFUN. \end_layout +\begin_layout Standard +LFUNs are also used in the files that define keyboard shortcuts, menu or + toolbar items. + So if you want to change\SpecialChar \slash{} +customize the user interface, you need to deal + with LFUNs. + Furthermore, external programs can use LFUNs to communicate with and +\begin_inset Quotes eld \end_inset - -\begin_inset VSpace 1cm +remote-control +\begin_inset Quotes erd \end_inset + LyX. + Finally, you can also issue LFUNs directly via the so called mini-buffer + which can be opened via +\begin_inset Info +type "shortcuts" +arg "command-execute" +\end_inset +. +\end_layout + +\begin_layout Standard +In the following, all LFUNs are listed, categorized by function. +\end_layout + +\begin_layout Section +Layout Functions (Font, Layout and Textclass related) \end_layout \begin_layout Subsection* -LFUN_ACCENT_ACUTE +drop-layouts-choice +\end_layout +\begin_layout Description +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. +\end_layout +\begin_layout Description +Syntax drop-layouts-choice +\end_layout + +\begin_layout Subsection* +environment-split +\end_layout +\begin_layout Description +Action Splits the current environment with a Separator. +\end_layout +\begin_layout Description +Syntax environment-split [outer] +\end_layout +\begin_layout Description +Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy. +\end_layout +\begin_layout Description +Origin spitz, 23 Dec 2012 +\end_layout + +\begin_layout Subsection* +font-bold +\end_layout +\begin_layout Description +Action Toggles the bold font (selection-wise) using mathbf in math. +\end_layout +\begin_layout Description +Syntax font-bold +\end_layout + +\begin_layout Subsection* +font-boldsymbol +\end_layout +\begin_layout Description +Action Toggles the bold font (selection-wise) using boldsymbol in math. +\end_layout +\begin_layout Description +Syntax font-boldsymbol +\end_layout + +\begin_layout Subsection* +font-default +\end_layout +\begin_layout Description +Action Reverts the settings of the font to the default values (selection-wise). +\end_layout +\begin_layout Description +Syntax font-default +\end_layout + +\begin_layout Subsection* +font-emph +\end_layout +\begin_layout Description +Action Toggles the emphasis font style (selection-wise). +\end_layout +\begin_layout Description +Syntax font-emph +\end_layout + +\begin_layout Subsection* +font-frak +\end_layout +\begin_layout Description +Action Toggles Fraktur family font (math-mode, selection-wise). +\end_layout +\begin_layout Description +Syntax font-frak +\end_layout +\begin_layout Description +Origin vermeer, 10 Jan 2002 +\end_layout + +\begin_layout Subsection* +font-ital +\end_layout +\begin_layout Description +Action Toggles Italics font shape (math-mode, selection-wise). +\end_layout +\begin_layout Description +Syntax font-ital +\end_layout +\begin_layout Description +Origin vermeer, 10 Jan 2002 +\end_layout + +\begin_layout Subsection* +font-noun +\end_layout +\begin_layout Description +Action Toggles Noun text style font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-noun +\end_layout + +\begin_layout Subsection* +font-roman +\end_layout +\begin_layout Description +Action Toggles Roman family font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-roman +\end_layout + +\begin_layout Subsection* +font-sans +\end_layout +\begin_layout Description +Action Toggles Sans Serif family font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-sans +\end_layout + +\begin_layout Subsection* +font-size +\end_layout +\begin_layout Description +Action Sets font size according to lyx format string. +\end_layout +\begin_layout Description +Syntax font-size +\end_layout +\begin_layout Description +Params : tiny|scriptsize|footnotesize|small|normal|large|larger| +\begin_inset Newline newline +\end_inset + +largest|huge|giant|increase|decrease|default +\end_layout + +\begin_layout Subsection* +font-state +\end_layout +\begin_layout Description +Action Returns the info about the current font. +\end_layout +\begin_layout Description +Syntax font-state +\end_layout + +\begin_layout Subsection* +font-strikeout +\end_layout +\begin_layout Description +Action Toggles strikeout (strike-through) in the font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-strikeout +\end_layout +\begin_layout Description +Origin sanda, 3 May 2009 +\end_layout + +\begin_layout Subsection* +font-typewriter +\end_layout +\begin_layout Description +Action Toggles the typewriter family font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-typewriter +\end_layout + +\begin_layout Subsection* +font-underline +\end_layout +\begin_layout Description +Action Toggles underline in the font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-underline +\end_layout + +\begin_layout Subsection* +font-underunderline +\end_layout +\begin_layout Description +Action Toggles double underline in the font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-underunderline +\end_layout +\begin_layout Description +Origin sanda, 5 May 2009 +\end_layout + +\begin_layout Subsection* +font-underwave +\end_layout +\begin_layout Description +Action Toggles wavy underline in the font (selection-wise). +\end_layout +\begin_layout Description +Syntax font-underwave +\end_layout +\begin_layout Description +Origin sanda, 5 May 2009 +\end_layout + +\begin_layout Subsection* +layout +\end_layout +\begin_layout Description +Action Sets the layout (that is, environment) for the current paragraph. +\end_layout +\begin_layout Description +Syntax layout +\end_layout +\begin_layout Description +Params : the layout to use +\end_layout + +\begin_layout Subsection* +layout-module-add +\end_layout +\begin_layout Description +Action Adds a module. +\end_layout +\begin_layout Description +Notion Adds a module to the list of included modules for the current buffer. +\end_layout +\begin_layout Description +Syntax layout-module-add +\end_layout +\begin_layout Description +Params : the module to be added +\end_layout +\begin_layout Description +Origin rgh, 25 August 2007 +\end_layout + +\begin_layout Subsection* +layout-modules-clear +\end_layout +\begin_layout Description +Action Clears the module list. +\end_layout +\begin_layout Description +Notion Clears the list of included modules for the current buffer. +\end_layout +\begin_layout Description +Syntax layout-modules-clear +\end_layout +\begin_layout Description +Origin rgh, 25 August 2007 +\end_layout + +\begin_layout Subsection* +layout-paragraph +\end_layout +\begin_layout Description +Action Launches the paragraph settings dialog. +\end_layout +\begin_layout Description +Syntax layout-paragraph +\end_layout + +\begin_layout Subsection* +layout-reload +\end_layout +\begin_layout Description +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. +\end_layout +\begin_layout Description +Syntax layout-reload +\end_layout +\begin_layout Description +Origin rgh, 3 September 2007 +\end_layout + +\begin_layout Subsection* +layout-tabular +\end_layout +\begin_layout Description +Action Launches the tabular settings dialog. +\end_layout +\begin_layout Description +Syntax layout-tabular +\end_layout +\begin_layout Description +Origin Jug, 31 Jul 2000 +\end_layout + +\begin_layout Subsection* +screen-font-update +\end_layout +\begin_layout Description +Action Update fonts and its metrics. +\end_layout +\begin_layout Description +Notion Automatically called after zoom, dpi, font names, or norm change. +\end_layout +\begin_layout Description +Syntax screen-font-update +\end_layout +\begin_layout Description +Origin ARRae, 13 Aug 2000 +\end_layout + +\begin_layout Subsection* +textclass-apply +\end_layout +\begin_layout Description +Action Sets the text class for the current buffer. +\end_layout +\begin_layout Description +Syntax textclass-apply +\end_layout +\begin_layout Description +Params : the textclass to set. Note that this must be the filename, minus the ".layout" extension. +\end_layout + +\begin_layout Subsection* +textclass-load +\end_layout +\begin_layout Description +Action Loads information for a textclass from disk. +\end_layout +\begin_layout Description +Syntax textclass-load +\end_layout +\begin_layout Description +Params : the textclass to load. Note that this must be the filename, minus the ".layout" extension. +\end_layout + +\begin_layout Subsection* +textstyle-apply +\end_layout +\begin_layout Description +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. +\end_layout +\begin_layout Description +Syntax textstyle-apply +\end_layout +\begin_layout Description +Origin leeming, 12 Mar 2003 +\end_layout + +\begin_layout Subsection* +textstyle-update +\end_layout +\begin_layout Description +Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY. +\end_layout +\begin_layout Description +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. +\begin_inset Newline newline +\end_inset + +Use lyx -dbg action for exact syntax of text-style dialog parameters. +\end_layout +\begin_layout Description +Origin leeming, 12 Mar 2003 +\end_layout + +\begin_layout Section +Editing Functions (Cursor and Mouse Movement, Copy/Paste etc.) +\end_layout +\begin_layout Subsection* +accent-acute \end_layout \begin_layout Description Action Adds an acute accent to the next character typed. @@ -125,7 +536,7 @@ Syntax accent-acute \end_layout \begin_layout Subsection* -LFUN_ACCENT_BREVE +accent-breve \end_layout \begin_layout Description Action Adds a breve accent to the next character typed. @@ -135,7 +546,7 @@ Syntax accent-breve \end_layout \begin_layout Subsection* -LFUN_ACCENT_CARON +accent-caron \end_layout \begin_layout Description Action Adds a caron to the next character typed. @@ -145,7 +556,7 @@ Syntax accent-caron \end_layout \begin_layout Subsection* -LFUN_ACCENT_CEDILLA +accent-cedilla \end_layout \begin_layout Description Action Adds a cedilla to the next character typed. @@ -155,7 +566,7 @@ Syntax accent-cedilla \end_layout \begin_layout Subsection* -LFUN_ACCENT_CIRCLE +accent-circle \end_layout \begin_layout Description Action Adds a circle accent to the next character typed. @@ -165,7 +576,7 @@ Syntax accent-circle \end_layout \begin_layout Subsection* -LFUN_ACCENT_CIRCUMFLEX +accent-circumflex \end_layout \begin_layout Description Action Adds a circumflex to the next character typed. @@ -175,7 +586,7 @@ Syntax accent-circumflex \end_layout \begin_layout Subsection* -LFUN_ACCENT_DOT +accent-dot \end_layout \begin_layout Description Action Adds a dot accent to the next character typed. @@ -185,7 +596,7 @@ Syntax accent-dot \end_layout \begin_layout Subsection* -LFUN_ACCENT_GRAVE +accent-grave \end_layout \begin_layout Description Action Adds a grave accent to the next character typed. @@ -195,7 +606,7 @@ Syntax accent-grave \end_layout \begin_layout Subsection* -LFUN_ACCENT_HUNGARIAN_UMLAUT +accent-hungarian-umlaut \end_layout \begin_layout Description Action Adds a Hungarian umlaut to the next character typed. @@ -205,7 +616,7 @@ Syntax accent-grave \end_layout \begin_layout Subsection* -LFUN_ACCENT_MACRON +accent-macron \end_layout \begin_layout Description Action Adds a macron to the next character typed. @@ -215,7 +626,7 @@ Syntax accent-macron \end_layout \begin_layout Subsection* -LFUN_ACCENT_OGONEK +accent-ogonek \end_layout \begin_layout Description Action Adds an ogonek accent to the next character typed. @@ -225,7 +636,7 @@ Syntax accent-ogonek \end_layout \begin_layout Subsection* -LFUN_ACCENT_TIE +accent-tie \end_layout \begin_layout Description Action Adds a tie over the next two character typed. @@ -238,7 +649,7 @@ Syntax accent-tie \end_layout \begin_layout Subsection* -LFUN_ACCENT_TILDE +accent-tilde \end_layout \begin_layout Description Action Adds a tilde over the next character typed. @@ -248,7 +659,7 @@ Syntax accent-tilde \end_layout \begin_layout Subsection* -LFUN_ACCENT_UMLAUT +accent-umlaut \end_layout \begin_layout Description Action Adds an umlaut over the next character typed. @@ -258,7 +669,7 @@ Syntax accent-umlaut \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERBAR +accent-underbar \end_layout \begin_layout Description Action Adds a bar under the next character typed. @@ -268,7 +679,7 @@ Syntax accent-underbar \end_layout \begin_layout Subsection* -LFUN_ACCENT_UNDERDOT +accent-underdot \end_layout \begin_layout Description Action Adds a dot under the next character typed. @@ -278,7 +689,7 @@ Syntax accent-underdot \end_layout \begin_layout Subsection* -LFUN_ALL_CHANGES_ACCEPT +all-changes-accept \end_layout \begin_layout Description Action Accepts all tracked changes in the document. @@ -291,7 +702,7 @@ Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_ALL_CHANGES_REJECT +all-changes-reject \end_layout \begin_layout Description Action Rejects all tracked changes in the document. @@ -307,7 +718,7 @@ Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_APPENDIX +appendix \end_layout \begin_layout Description Action Start (or remove) Appendix on the given cursor position. @@ -320,7 +731,7 @@ Origin ettrich, 5 May 1998 \end_layout \begin_layout Subsection* -LFUN_ARGUMENT_INSERT +argument-insert \end_layout \begin_layout Description Action Inserts an argument (short title) inset. @@ -336,7 +747,7 @@ Origin vermeer, 12 Aug 2002 \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_ADD +bibtex-database-add \end_layout \begin_layout Description Action Adds database, which will be used for bibtex citations. @@ -352,7 +763,7 @@ Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_BIBTEX_DATABASE_DEL +bibtex-database-del \end_layout \begin_layout Description Action Adds database, which will be used for bibtex citations. @@ -368,7 +779,7 @@ Origin Ale, 30 May 1997 \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_CLEAR +bookmark-clear \end_layout \begin_layout Description Action Clears the list of saved bookmarks. @@ -381,7 +792,7 @@ Origin bpeng, 31 October 2006 \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_GOTO +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. @@ -412,7 +823,7 @@ Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_BOOKMARK_SAVE +bookmark-save \end_layout \begin_layout Description Action Save a bookmark. @@ -431,7 +842,7 @@ Origin Dekel, 27 January 2001 \end_layout \begin_layout Subsection* -LFUN_BOX_INSERT +box-insert \end_layout \begin_layout Description Action Inserts Box inset. @@ -451,94 +862,7 @@ Origin vermeer, 7 Oct 2003 \end_layout \begin_layout Subsection* -LFUN_BRANCHES_RENAME -\end_layout -\begin_layout Description -Action Rename all branches of a given name in a document. -\end_layout -\begin_layout Description -Syntax branches-rename -\end_layout -\begin_layout Description -Params : Current name of the branch to be renamed : New name of the branch -\end_layout -\begin_layout Description -Origin spitz, 9 Jul 2009 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_ACTIVATE -\end_layout -\begin_layout Description -Action Activate the branch. -\end_layout -\begin_layout Description -Syntax branch-activate -\end_layout -\begin_layout Description -Params : The branch to activate -\end_layout -\begin_layout Description -Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx -\begin_inset Newline newline -\end_inset - -could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually. -\end_layout -\begin_layout Description -Origin rgh, 27 May 2008 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_ADD -\end_layout -\begin_layout Description -Action Add a branch to the buffer's BranchList. -\end_layout -\begin_layout Description -Syntax branch-add -\end_layout -\begin_layout Description -Params : Name of the branch to add -\end_layout -\begin_layout Description -Origin spitz, 7 Jul 2009 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_ADD_INSERT -\end_layout -\begin_layout Description -Action Create new branch and directly put the branch inset into the document. -\end_layout -\begin_layout Description -Syntax branch-add-insert [] -\end_layout -\begin_layout Description -Params : Branch name. If it is not specified, you will be asked. -\end_layout -\begin_layout Description -Origin sanda, 10 Jul 2009 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_DEACTIVATE -\end_layout -\begin_layout Description -Action De-activate the branch. -\end_layout -\begin_layout Description -Syntax branch-deactivate -\end_layout -\begin_layout Description -Params : The branch to deactivate -\end_layout -\begin_layout Description -Origin rgh, 27 May 2008 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_INSERT +branch-insert \end_layout \begin_layout Description Action Inserts branch inset. @@ -551,59 +875,7 @@ Origin vermeer, 17 Aug 2003 \end_layout \begin_layout Subsection* -LFUN_BRANCH_MASTER_ACTIVATE -\end_layout -\begin_layout Description -Action Activate the branch in the master buffer. -\end_layout -\begin_layout Description -Syntax branch-master-activate -\end_layout -\begin_layout Description -Params : The branch to activate -\end_layout -\begin_layout Description -Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx -\begin_inset Newline newline -\end_inset - -could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually. -\end_layout -\begin_layout Description -Origin spitz, 30 Sep 2012 -\end_layout - -\begin_layout Subsection* -LFUN_BRANCH_MASTER_DEACTIVATE -\end_layout -\begin_layout Description -Action De-activate the branch in the master buffer. -\end_layout -\begin_layout Description -Syntax branch-master-deactivate -\end_layout -\begin_layout Description -Params : The branch to deactivate -\end_layout -\begin_layout Description -Origin spitz, 30 Sep 2012 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_AUTO_SAVE -\end_layout -\begin_layout Description -Action Saves the current buffer to a temporary file. -\end_layout -\begin_layout Description -Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer. -\end_layout -\begin_layout Description -Syntax buffer-auto-save -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_BEGIN +buffer-begin \end_layout \begin_layout Description Action Move the cursor to the beginning of the document. @@ -613,7 +885,7 @@ Syntax buffer-begin \end_layout \begin_layout Subsection* -LFUN_BUFFER_BEGIN_SELECT +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. @@ -623,65 +895,7 @@ Syntax buffer-begin-select \end_layout \begin_layout Subsection* -LFUN_BUFFER_CHILD_OPEN -\end_layout -\begin_layout Description -Action Loads the given child document. -\end_layout -\begin_layout Description -Notion The current document is treated as a parent. -\end_layout -\begin_layout Description -Syntax buffer-child-open -\end_layout -\begin_layout Description -Params : Filename of the child. The directory of the parent is assumed by default. -\end_layout -\begin_layout Description -Origin Ale, 28 May 1997 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_CHKTEX -\end_layout -\begin_layout Description -Action Runs chktex for the current document. -\end_layout -\begin_layout Description -Syntax buffer-chktex -\end_layout -\begin_layout Description -Origin Asger, 30 Oct 1997 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_CLOSE -\end_layout -\begin_layout Description -Action Closes the current buffer. -\end_layout -\begin_layout Description -Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified. -\end_layout -\begin_layout Description -Syntax buffer-close -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_CLOSE_ALL -\end_layout -\begin_layout Description -Action Closes all buffers. -\end_layout -\begin_layout Description -Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified. -\end_layout -\begin_layout Description -Syntax buffer-close-all -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_END +buffer-end \end_layout \begin_layout Description Action Move the cursor to the end of the document. @@ -691,7 +905,7 @@ Syntax buffer-end \end_layout \begin_layout Subsection* -LFUN_BUFFER_END_SELECT +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. @@ -701,546 +915,7 @@ Syntax buffer-end-select \end_layout \begin_layout Subsection* -LFUN_BUFFER_EXPORT -\end_layout -\begin_layout Description -Action Exports the current buffer (document) to the given format. -\end_layout -\begin_layout Description -Syntax buffer-export [] -\end_layout -\begin_layout Description -Params is either "custom" or one of the formats which you can find in Tools->Preferences->File formats->Format. Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex for pdflatex) or "ps" for postscript. -\begin_inset Newline newline -\end_inset - -In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM. If present, this argument provides the export destination filename. Its containing folder will also be the destination folder, where all the needed external files will be copied. -\end_layout -\begin_layout Description -Origin Lgb, 29 Jul 1997 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_EXPORT_AS -\end_layout -\begin_layout Description -Action Opens a dialog for exporting the current buffer. -\end_layout -\begin_layout Description -Syntax buffer-export-as [] -\end_layout -\begin_layout Description -Params is the export format initially selected in the dialog. You can pass any of the formats which you can find in Tools->Preferences->File formats->Format, provided it has the "document" flag set. If no format is specified the dialog will start with the default output format of the current document. -\end_layout -\begin_layout Description -Sample buffer-export-as pdf2 -\end_layout -\begin_layout Description -Origin tommaso, 6 Oct 2011 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_EXPORT_CUSTOM -\end_layout -\begin_layout Description -Action Exports the current buffer (document) from the given format using the given command on it. -\end_layout -\begin_layout Description -Syntax buffer-export-custom -\end_layout -\begin_layout Description -Params format to start from (LyX will care to produce such intermediate file). -\begin_inset Newline newline -\end_inset - - this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file. -\end_layout -\begin_layout Description -Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps -\end_layout -\begin_layout Description -Origin leeming, 27 Mar 2004 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_FORALL -\end_layout -\begin_layout Description -Action Applies a command to all non-hidden buffers. -\end_layout -\begin_layout Description -Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window. -\end_layout -\begin_layout Description -Syntax buffer-forall -\end_layout -\begin_layout Description -Params : The command to be applied to the buffers. -\end_layout -\begin_layout Description -Sample Close all Notes in buffers: -\begin_inset Newline newline -\end_inset - - buffer-forall inset-forall Note inset-toggle close -\begin_inset Newline newline -\end_inset - -Toggle change tracking on buffers: -\begin_inset Newline newline -\end_inset - - buffer-forall changes-track -\begin_inset Newline newline -\end_inset - -Toggle read-only for buffers: -\begin_inset Newline newline -\end_inset - - buffer-forall buffer-toggle-read-only -\begin_inset Newline newline -\end_inset - -Show statistics for individual buffers: -\begin_inset Newline newline -\end_inset - - buffer-forall statistics -\begin_inset Newline newline -\end_inset - -Activate the branch named "Solutions" in buffers: -\begin_inset Newline newline -\end_inset - - buffer-forall branch-activate Solutions -\begin_inset Newline newline -\end_inset - -Export buffers to PDF (pdflatex): -\begin_inset Newline newline -\end_inset - - buffer-forall buffer-export pdf2 -\begin_inset Newline newline -\end_inset - - -\end_layout -\begin_layout Description -Origin scottkostyshak, 20 Jul 2012 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_IMPORT -\end_layout -\begin_layout Description -Action Import a given file as a lyx document. -\end_layout -\begin_layout Description -Notion File can be imported iff lyx file format is (transitively) reachable via defined converters in preferences. Look in the File->Import menu to get an idea of the currently active import formats. -\end_layout -\begin_layout Description -Syntax buffer-import [] -\end_layout -\begin_layout Description -Origin Asger, 24 Jul 1998 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_LANGUAGE -\end_layout -\begin_layout Description -Action Set language of the current document. -\end_layout -\begin_layout Description -Syntax buffer-language -\end_layout -\begin_layout Description -Params : language name. See lib/languages for list. -\end_layout -\begin_layout Description -Origin leeming, 30 Mar 2004 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_NEW -\end_layout -\begin_layout Description -Action Creates a new buffer (that is, document) and switches to it. -\end_layout -\begin_layout Description -Notion Implicit path can be set in Preferences dialog. -\end_layout -\begin_layout Description -Syntax buffer-new [] -\end_layout -\begin_layout Description -Params : filename of created file with absolute path. -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_NEW_TEMPLATE -\end_layout -\begin_layout Description -Action Creates a new buffer (that is, document) from a template. -\end_layout -\begin_layout Description -Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog. -\end_layout -\begin_layout Description -Syntax buffer-new-template [] -\end_layout -\begin_layout Description -Params : filename of created file with absolute path. -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_NEXT -\end_layout -\begin_layout Description -Action Switch to the next opened document. -\end_layout -\begin_layout Description -Notion Note that this does not necessarily mean next in tabbar (for full list see View menu). -\end_layout -\begin_layout Description -Syntax buffer-next -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_PARAMS_APPLY -\end_layout -\begin_layout Description -Action Apply the given settings to the current document. -\end_layout -\begin_layout Description -Syntax buffer-params-apply [] -\end_layout -\begin_layout Description -Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. -\end_layout -\begin_layout Description -Origin leeming, 30 Mar 2004 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_PREVIOUS -\end_layout -\begin_layout Description -Action Switch to the previous opened document. -\end_layout -\begin_layout Description -Syntax buffer-previous -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_PRINT -\end_layout -\begin_layout Description -Action Prints the current document. -\end_layout -\begin_layout Description -Notion Many settings can be given via the preferences dialog. -\end_layout -\begin_layout Description -Syntax buffer-print -\end_layout -\begin_layout Description -Params is either "printer" or "file". -\begin_inset Newline newline -\end_inset - - is either "default" or file name or printer name. -\begin_inset Newline newline -\end_inset - - command ensuring the printing job. -\end_layout -\begin_layout Description -Sample buffer-print file "/trash/newfile1.ps" "dvips" -\end_layout -\begin_layout Description -Origin leeming, 28 Mar 2004 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_RELOAD -\end_layout -\begin_layout Description -Action Reverts opened document. -\end_layout -\begin_layout Description -Syntax buffer-reload -\end_layout -\begin_layout Description -Origin Asger, 2 Feb 1997 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_SAVE_AS_DEFAULT -\end_layout -\begin_layout Description -Action Save the current document settings as default. -\end_layout -\begin_layout Description -Notion The file will will be saved into ~/.lyx/templates/defaults.lyx . -\end_layout -\begin_layout Description -Syntax buffer-save-as-default [] -\end_layout -\begin_layout Description -Params : contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file. -\end_layout -\begin_layout Description -Origin leeming, 30 Mar 2004 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_SWITCH -\end_layout -\begin_layout Description -Action Display and switch to the given buffer. -\end_layout -\begin_layout Description -Syntax buffer-switch -\end_layout -\begin_layout Description -Params : path and filename of already opened (but possibly hidden) document which is to be shown. -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_TOGGLE_COMPRESSION -\end_layout -\begin_layout Description -Action Toggles compression of the current document on/off. -\end_layout -\begin_layout Description -Syntax buffer-toggle-compression -\end_layout -\begin_layout Description -Origin bpeng, 27 Apr 2006 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_TOGGLE_OUTPUT_SYNC -\end_layout -\begin_layout Description -Action Toggles including of resources for forward/reverse search of the given document. -\end_layout -\begin_layout Description -Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences. -\end_layout -\begin_layout Description -Syntax buffer-toggle-output-sync -\end_layout -\begin_layout Description -Origin sanda, 25 May 2010 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_TOGGLE_READ_ONLY -\end_layout -\begin_layout Description -Action Toggle editing mode of the current document between read/write and read-only. -\end_layout -\begin_layout Description -Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking. -\end_layout -\begin_layout Description -Syntax buffer-toggle-read-only -\end_layout -\begin_layout Description -Origin Lgb, 27 May 1997 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_UPDATE -\end_layout -\begin_layout Description -Action Exports the current document and put the result into the temporary directory. -\end_layout -\begin_layout Description -Notion In case you are already viewing the exported document (see LFUN_BUFFER_VIEW) the output will be rewritten - updated. This is useful in case your viewer is able to detect such changes (e.g. ghostview for postscript). -\end_layout -\begin_layout Description -Syntax buffer-update [] -\end_layout -\begin_layout Description -Params : The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used. -\end_layout -\begin_layout Description -Origin Dekel, 5 Aug 2000 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_VIEW -\end_layout -\begin_layout Description -Action Displays current buffer in chosen format. -\end_layout -\begin_layout Description -Notion Displays the contents of the current buffer in the chosen format, for example, PDF or DVI. This runs the necessary converter, calls the defined viewer, and so forth. -\end_layout -\begin_layout Description -Syntax buffer-view [] -\end_layout -\begin_layout Description -Params : The format to display, where this is one of the formats defined (in the current GUI) in the Tools>Preferences>File Formats dialog. If no format is given, the default format as specified in the same dialog is used. -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_WRITE -\end_layout -\begin_layout Description -Action Saves the current buffer. -\end_layout -\begin_layout Description -Notion Saves the current buffer to disk, using the filename that is already associated with the buffer, asking for one if none is yet assigned. -\end_layout -\begin_layout Description -Syntax buffer-write -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_WRITE_ALL -\end_layout -\begin_layout Description -Action Save all changed documents. -\end_layout -\begin_layout Description -Syntax buffer-write-all -\end_layout -\begin_layout Description -Origin rgh, gpothier 6 Aug 2007 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_WRITE_AS -\end_layout -\begin_layout Description -Action Rename and save current buffer. -\end_layout -\begin_layout Description -Syntax buffer-write-as -\end_layout -\begin_layout Description -Params : New name of the buffer/file. A relative path is with respect to the original location of the buffer/file. -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_ZOOM_IN -\end_layout -\begin_layout Description -Action Increases the zoom of the screen fonts. -\end_layout -\begin_layout Description -Syntax buffer-zoom-in [] -\end_layout -\begin_layout Description -Params : The zoom in %, the default is 20. -\end_layout -\begin_layout Description -Origin vfr, 30 Mar 2009 -\end_layout - -\begin_layout Subsection* -LFUN_BUFFER_ZOOM_OUT -\end_layout -\begin_layout Description -Action Decreases the zoom of the screen fonts. -\end_layout -\begin_layout Description -Syntax buffer-zoom-out [] -\end_layout -\begin_layout Description -Params : The zoom in %, the default is 20. -\end_layout -\begin_layout Description -Origin vfr, 30 Mar 2009 -\end_layout - -\begin_layout Subsection* -LFUN_BUILD_PROGRAM -\end_layout -\begin_layout Description -Action Generates the code (literate programming). -\end_layout -\begin_layout Description -Notion Latex file with extension -\backslash -literate_extension is generated. Then LyX invokes -\backslash -build_command (with a default of ``make'') to generate the code and -\backslash -build_error_filter to process the compilation error messages. -\begin_inset Newline newline -\end_inset - -In case you want to process your literate file with a script, or some other program, just insert in your lyxrc file an entry with: -\begin_inset Newline newline -\end_inset - - -\backslash -build_command "my_script my_arguments" -\begin_inset Newline newline -\end_inset - -The -\backslash -build_error_filter differs from the -\backslash -literate_error_filter only in that the former will identify error messages from your compiler. -\end_layout -\begin_layout Description -Syntax build-program -\end_layout - -\begin_layout Subsection* -LFUN_CALL -\end_layout -\begin_layout Description -Action Executes a command defined in a .def file. -\end_layout -\begin_layout Description -Notion The definitions are by default read from lib/commands/default.def. -\begin_inset Newline newline -\end_inset - -A .def file allows to define a command with -\backslash -define "" "" where is the name of the new command and is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE). -\backslash -def_file "FileName" allows to include another .def file. -\begin_inset Newline newline -\end_inset - -This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/.png this is the way to assign an image to a complex command-sequence. -\end_layout -\begin_layout Description -Syntax call -\end_layout -\begin_layout Description -Params : Name of the command that must be called. -\end_layout -\begin_layout Description -Origin broider, 2 Oct 2007 -\end_layout - -\begin_layout Subsection* -LFUN_CANCEL -\end_layout -\begin_layout Description -Action Cancels sequence prepared by LFUN_META_PREFIX . -\end_layout -\begin_layout Description -Syntax cancel -\end_layout - -\begin_layout Subsection* -LFUN_CAPTION_INSERT +caption-insert \end_layout \begin_layout Description Action Inserts a caption inset. @@ -1253,7 +928,7 @@ Origin Lgb, 18 Jul 2000 \end_layout \begin_layout Subsection* -LFUN_CELL_BACKWARD +cell-backward \end_layout \begin_layout Description Action Moves the cursor to the previous cell inside the table. @@ -1266,7 +941,7 @@ Origin Jug, 22 May 2000 \end_layout \begin_layout Subsection* -LFUN_CELL_FORWARD +cell-forward \end_layout \begin_layout Description Action Moves the cursor to the next cell inside the table. @@ -1276,7 +951,7 @@ Syntax cell-forward \end_layout \begin_layout Subsection* -LFUN_CELL_SPLIT +cell-split \end_layout \begin_layout Description Action Splits cell and shifts right part to the next cell (inside the math grid). @@ -1289,46 +964,7 @@ Origin Ale, 15 May 1997 \end_layout \begin_layout Subsection* -LFUN_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. -\end_layout -\begin_layout Description -Syntax changes-merge -\end_layout -\begin_layout Description -Origin Levon, 16 Oct 2002 -\end_layout - -\begin_layout Subsection* -LFUN_CHANGES_OUTPUT -\end_layout -\begin_layout Description -Action Toggles showing of change tracking in typesetted output. -\end_layout -\begin_layout Description -Syntax changes-output -\end_layout -\begin_layout Description -Origin jspitzm, 21 Jan 2005 -\end_layout - -\begin_layout Subsection* -LFUN_CHANGES_TRACK -\end_layout -\begin_layout Description -Action Toggles change tracking to on/off. -\end_layout -\begin_layout Description -Syntax changes-track -\end_layout -\begin_layout Description -Origin levon, 1 Oct 2002 -\end_layout - -\begin_layout Subsection* -LFUN_CHANGE_ACCEPT +change-accept \end_layout \begin_layout Description Action Accepts tracked change inside the selection. @@ -1341,7 +977,7 @@ Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_CHANGE_NEXT +change-next \end_layout \begin_layout Description Action Moves the cursor to the position of the next change of the change tracking records. @@ -1354,7 +990,7 @@ Origin schmitt, 4 Oct 2006 \end_layout \begin_layout Subsection* -LFUN_CHANGE_PREVIOUS +change-previous \end_layout \begin_layout Description Action Moves the cursor to the position of the previous change of the change tracking records. @@ -1367,7 +1003,7 @@ Origin vfr, 4 Apr 2009 \end_layout \begin_layout Subsection* -LFUN_CHANGE_REJECT +change-reject \end_layout \begin_layout Description Action Rejects tracked change inside the selection. @@ -1380,20 +1016,46 @@ Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_CHARS_TRANSPOSE +changes-merge \end_layout \begin_layout Description -Action Transposes the character at the cursor with the one before it. +Action Open change tracking dialog for merging and moves the cursor to the position of the next change. \end_layout \begin_layout Description -Syntax chars-transpose +Syntax changes-merge \end_layout \begin_layout Description -Origin Lgb, 25 Apr 2001 +Origin Levon, 16 Oct 2002 \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD +changes-output +\end_layout +\begin_layout Description +Action Toggles showing of change tracking in typesetted output. +\end_layout +\begin_layout Description +Syntax changes-output +\end_layout +\begin_layout Description +Origin jspitzm, 21 Jan 2005 +\end_layout + +\begin_layout Subsection* +changes-track +\end_layout +\begin_layout Description +Action Toggles change tracking to on/off. +\end_layout +\begin_layout Description +Syntax changes-track +\end_layout +\begin_layout Description +Origin levon, 1 Oct 2002 +\end_layout + +\begin_layout Subsection* +char-backward \end_layout \begin_layout Description Action Moves the cursor one position logically backwards. @@ -1406,7 +1068,7 @@ Syntax char-backward \end_layout \begin_layout Subsection* -LFUN_CHAR_BACKWARD_SELECT +char-backward-select \end_layout \begin_layout Description Action Moves the cursor one position logically backwards, adding traversed position to the selection. @@ -1419,7 +1081,7 @@ Syntax char-backward-select \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_BACKWARD +char-delete-backward \end_layout \begin_layout Description Action Deletes one character in the backward direction (usually the "BackSpace" key). @@ -1429,7 +1091,7 @@ Syntax char-delete-backward \end_layout \begin_layout Subsection* -LFUN_CHAR_DELETE_FORWARD +char-delete-forward \end_layout \begin_layout Description Action Deletes one character in the backward direction (usually the "Delete" key). @@ -1439,7 +1101,7 @@ Syntax char-delete-forward \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD +char-forward \end_layout \begin_layout Description Action Moves the cursor one position logically forward. @@ -1452,7 +1114,7 @@ Syntax char-forward \end_layout \begin_layout Subsection* -LFUN_CHAR_FORWARD_SELECT +char-forward-select \end_layout \begin_layout Description Action Moves the cursor one position logically forward, adding traversed position to the selection. @@ -1465,7 +1127,7 @@ Syntax char-forward-select \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT +char-left \end_layout \begin_layout Description Action Moves the cursor one position "to the left". @@ -1478,7 +1140,7 @@ Syntax char-left \end_layout \begin_layout Subsection* -LFUN_CHAR_LEFT_SELECT +char-left-select \end_layout \begin_layout Description Action Moves the cursor one position "to the left", adding traversed position to the selection. @@ -1491,7 +1153,7 @@ Syntax char-left-select \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT +char-right \end_layout \begin_layout Description Action Moves the cursor one position "to the right". @@ -1504,7 +1166,7 @@ Syntax char-right \end_layout \begin_layout Subsection* -LFUN_CHAR_RIGHT_SELECT +char-right-select \end_layout \begin_layout Description Action Moves the cursor one position "to the right", adding traversed position to the selection. @@ -1517,7 +1179,20 @@ Syntax char-right-select \end_layout \begin_layout Subsection* -LFUN_CITATION_INSERT +chars-transpose +\end_layout +\begin_layout Description +Action Transposes the character at the cursor with the one before it. +\end_layout +\begin_layout Description +Syntax chars-transpose +\end_layout +\begin_layout Description +Origin Lgb, 25 Apr 2001 +\end_layout + +\begin_layout Subsection* +citation-insert \end_layout \begin_layout Description Action Inserts citation from loaded citation database. @@ -1537,7 +1212,7 @@ Origin AAS, 97-02-23 \end_layout \begin_layout Subsection* -LFUN_CLIPBOARD_PASTE +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 colums if tha paste happens in a tabular inset. @@ -1556,7 +1231,7 @@ Origin Georg, 10 Jul 2006 \end_layout \begin_layout Subsection* -LFUN_CLIPBOARD_PASTE_SIMPLE +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 colums if the paste happens in a tabular inset. @@ -1569,29 +1244,7 @@ Params : "paragraph" will cause pasting as one paragraph, i.e. "Join lines" \end_layout \begin_layout Subsection* -LFUN_COMMAND_ALTERNATIVES -\end_layout -\begin_layout Description -Action Runs the first listed command that is enabled. -\end_layout -\begin_layout Description -Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context. -\end_layout -\begin_layout Description -Syntax command-alternatives -\end_layout -\begin_layout Description -Params : Sequence of commands separated by semicolons. -\end_layout -\begin_layout Description -Sample command-alternatives completion-accept;cell-forward -\end_layout -\begin_layout Description -Origin rgh, 24 September 2008 -\end_layout - -\begin_layout Subsection* -LFUN_COMMAND_EXECUTE +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. @@ -1604,71 +1257,7 @@ Syntax command-execute \end_layout \begin_layout Subsection* -LFUN_COMMAND_PREFIX -\end_layout -\begin_layout Description -Action Return the current key sequence and available options as a string. -\end_layout -\begin_layout Description -Notion No options are added if no current map exists. -\begin_inset Newline newline -\end_inset - -This is probably usable only with connection to lyxserver. -\end_layout -\begin_layout Description -Syntax command-prefix -\end_layout - -\begin_layout Subsection* -LFUN_COMMAND_SEQUENCE -\end_layout -\begin_layout Description -Action Run more commands (LFUN and its parameters) in a sequence. -\end_layout -\begin_layout Description -Syntax command-sequence -\end_layout -\begin_layout Description -Params : Sequence of commands separated by semicolons. -\end_layout -\begin_layout Description -Sample command-sequence cut; ert-insert; self-insert -\backslash -; paste; self-insert {}; inset-toggle; -\end_layout -\begin_layout Description -Origin Andre, 11 Nov 1999 -\end_layout - -\begin_layout Subsection* -LFUN_COMPLETION_ACCEPT -\end_layout -\begin_layout Description -Action Accept suggested completion. -\end_layout -\begin_layout Description -Syntax completion-accept -\end_layout -\begin_layout Description -Origin sanda, Sep 08 2008 -\end_layout - -\begin_layout Subsection* -LFUN_COMPLETION_CANCEL -\end_layout -\begin_layout Description -Action Try to cancel completion, either the popup or the inline completion. -\end_layout -\begin_layout Description -Syntax completion-cancel -\end_layout -\begin_layout Description -Origin sts, Sep 07 2008 -\end_layout - -\begin_layout Subsection* -LFUN_COMPLETION_COMPLETE +complete \end_layout \begin_layout Description Action Try to complete the word or command at the cursor position. @@ -1681,7 +1270,33 @@ Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COMPLETION_INLINE +completion-accept +\end_layout +\begin_layout Description +Action Accept suggested completion. +\end_layout +\begin_layout Description +Syntax completion-accept +\end_layout +\begin_layout Description +Origin sanda, Sep 08 2008 +\end_layout + +\begin_layout Subsection* +completion-cancel +\end_layout +\begin_layout Description +Action Try to cancel completion, either the popup or the inline completion. +\end_layout +\begin_layout Description +Syntax completion-cancel +\end_layout +\begin_layout Description +Origin sts, Sep 07 2008 +\end_layout + +\begin_layout Subsection* +completion-inline \end_layout \begin_layout Description Action Show the inline completion at the cursor position. @@ -1694,7 +1309,7 @@ Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COMPLETION_POPUP +completion-popup \end_layout \begin_layout Description Action Show the completion popup at the cursor position. @@ -1707,7 +1322,7 @@ Origin sts, Feb 19 2008 \end_layout \begin_layout Subsection* -LFUN_COPY +copy \end_layout \begin_layout Description Action Copies the current selection to the clipboard. @@ -1717,20 +1332,23 @@ Syntax copy \end_layout \begin_layout Subsection* -LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE +copy-label-as-reference \end_layout \begin_layout Description -Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement. +Action Copies the label at the cursor as a cross-reference to be pasted elsewhere. \end_layout \begin_layout Description -Syntax toggle-cursor-follows-scrollbar +Syntax copy-label-as-reference