lib/doc/LFUNs.lyx

   1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
   2 \lyxformat 474
   3 \begin_document
   4 \begin_header
   5 \textclass article
   6 \begin_preamble
   7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
   8 \renewenvironment{description}{\list{}{%
   9   \setlength{\itemsep}{-2pt}
  10   \advance\leftmargini6\p@ \itemindent-12\p@
  11   \labelwidth\z@ \let\makelabel\descriptionlabel}%
  12 }{
  13   \endlist
  14 }
  15 \end_preamble
  16 \use_default_options false
  17 \maintain_unincluded_children false
  18 \language english
  19 \language_package default
  20 \inputencoding auto
  21 \fontencoding global
  22 \font_roman default
  23 \font_sans default
  24 \font_typewriter default
  25 \font_math auto
  26 \font_default_family default
  27 \use_non_tex_fonts false
  28 \font_sc false
  29 \font_osf false
  30 \font_sf_scale 100
  31 \font_tt_scale 100
  32 \graphics default
  33 \default_output_format default
  34 \output_sync 0
  35 \bibtex_command default
  36 \index_command default
  37 \paperfontsize default
  38 \spacing single
  39 \use_hyperref false
  40 \papersize default
  41 \use_geometry true
  42 \use_package amsmath 1
  43 \use_package amssymb 1
  44 \use_package cancel 0
  45 \use_package esint 1
  46 \use_package mathdots 0
  47 \use_package mathtools 0
  48 \use_package mhchem 1
  49 \use_package stackrel 0
  50 \use_package stmaryrd 0
  51 \use_package undertilde 0
  52 \cite_engine basic
  53 \cite_engine_type default
  54 \biblio_style plain
  55 \use_bibtopic false
  56 \use_indices false
  57 \paperorientation portrait
  58 \suppress_date false
  59 \justification true
  60 \use_refstyle 0
  61 \index Index
  62 \shortcut idx
  63 \color #008000
  64 \end_index
  65 \leftmargin 2.5cm
  66 \topmargin 2cm
  67 \rightmargin 3cm
  68 \bottommargin 2.5cm
  69 \secnumdepth 3
  70 \tocdepth 3
  71 \paragraph_separation indent
  72 \paragraph_indentation default
  73 \quotes_language english
  74 \papercolumns 1
  75 \papersides 1
  76 \paperpagestyle default
  77 \tracking_changes false
  78 \output_changes false
  79 \html_math_output 0
  80 \html_css_as_file 0
  81 \html_be_strict false
  82 \end_header
  83
  84 \begin_body
  85
  86 \begin_layout Title
  87 LyX Functions (LFUNs)
  88 \end_layout
  89
  90 \begin_layout Author
  91 The LyX Team
  92 \end_layout
  93
  94 \begin_layout Date
  95 2014-02-10
  96 \end_layout
  97
  98 \begin_layout Standard
  99 \begin_inset ERT
 100 status collapsed
 101
 102 \begin_layout Plain Layout
 103
 104
 105 \backslash
 106 thispagestyle{empty}
 107 \end_layout
 108
 109 \end_inset
 110
 111
 112 \begin_inset VSpace 1cm
 113 \end_inset
 114
 115
 116 \end_layout
 117 \begin_layout Subsection*
 118 LFUN_ACCENT_ACUTE
 119 \end_layout
 120 \begin_layout Description
 121 Action Adds an acute accent to the next character typed.
 122 \end_layout
 123 \begin_layout Description
 124 Syntax accent-acute
 125 \end_layout
 126
 127 \begin_layout Subsection*
 128 LFUN_ACCENT_BREVE
 129 \end_layout
 130 \begin_layout Description
 131 Action Adds a breve accent to the next character typed.
 132 \end_layout
 133 \begin_layout Description
 134 Syntax accent-breve
 135 \end_layout
 136
 137 \begin_layout Subsection*
 138 LFUN_ACCENT_CARON
 139 \end_layout
 140 \begin_layout Description
 141 Action Adds a caron to the next character typed.
 142 \end_layout
 143 \begin_layout Description
 144 Syntax accent-caron
 145 \end_layout
 146
 147 \begin_layout Subsection*
 148 LFUN_ACCENT_CEDILLA
 149 \end_layout
 150 \begin_layout Description
 151 Action Adds a cedilla to the next character typed.
 152 \end_layout
 153 \begin_layout Description
 154 Syntax accent-cedilla
 155 \end_layout
 156
 157 \begin_layout Subsection*
 158 LFUN_ACCENT_CIRCLE
 159 \end_layout
 160 \begin_layout Description
 161 Action Adds a circle accent to the next character typed.
 162 \end_layout
 163 \begin_layout Description
 164 Syntax accent-circle
 165 \end_layout
 166
 167 \begin_layout Subsection*
 168 LFUN_ACCENT_CIRCUMFLEX
 169 \end_layout
 170 \begin_layout Description
 171 Action Adds a circumflex to the next character typed.
 172 \end_layout
 173 \begin_layout Description
 174 Syntax accent-circumflex
 175 \end_layout
 176
 177 \begin_layout Subsection*
 178 LFUN_ACCENT_DOT
 179 \end_layout
 180 \begin_layout Description
 181 Action Adds a dot accent to the next character typed.
 182 \end_layout
 183 \begin_layout Description
 184 Syntax accent-dot
 185 \end_layout
 186
 187 \begin_layout Subsection*
 188 LFUN_ACCENT_GRAVE
 189 \end_layout
 190 \begin_layout Description
 191 Action Adds a grave accent to the next character typed.
 192 \end_layout
 193 \begin_layout Description
 194 Syntax accent-grave
 195 \end_layout
 196
 197 \begin_layout Subsection*
 198 LFUN_ACCENT_HUNGARIAN_UMLAUT
 199 \end_layout
 200 \begin_layout Description
 201 Action Adds a Hungarian umlaut to the next character typed.
 202 \end_layout
 203 \begin_layout Description
 204 Syntax accent-grave
 205 \end_layout
 206
 207 \begin_layout Subsection*
 208 LFUN_ACCENT_MACRON
 209 \end_layout
 210 \begin_layout Description
 211 Action Adds a macron to the next character typed.
 212 \end_layout
 213 \begin_layout Description
 214 Syntax accent-macron
 215 \end_layout
 216
 217 \begin_layout Subsection*
 218 LFUN_ACCENT_OGONEK
 219 \end_layout
 220 \begin_layout Description
 221 Action Adds an ogonek accent to the next character typed.
 222 \end_layout
 223 \begin_layout Description
 224 Syntax accent-ogonek
 225 \end_layout
 226
 227 \begin_layout Subsection*
 228 LFUN_ACCENT_TIE
 229 \end_layout
 230 \begin_layout Description
 231 Action Adds a tie over the next two character typed.
 232 \end_layout
 233 \begin_layout Description
 234 Notion The following char will finish the tie.
 235 \end_layout
 236 \begin_layout Description
 237 Syntax accent-tie
 238 \end_layout
 239
 240 \begin_layout Subsection*
 241 LFUN_ACCENT_TILDE
 242 \end_layout
 243 \begin_layout Description
 244 Action Adds a tilde over the next character typed.
 245 \end_layout
 246 \begin_layout Description
 247 Syntax accent-tilde
 248 \end_layout
 249
 250 \begin_layout Subsection*
 251 LFUN_ACCENT_UMLAUT
 252 \end_layout
 253 \begin_layout Description
 254 Action Adds an umlaut over the next character typed.
 255 \end_layout
 256 \begin_layout Description
 257 Syntax accent-umlaut
 258 \end_layout
 259
 260 \begin_layout Subsection*
 261 LFUN_ACCENT_UNDERBAR
 262 \end_layout
 263 \begin_layout Description
 264 Action Adds a bar under the next character typed.
 265 \end_layout
 266 \begin_layout Description
 267 Syntax accent-underbar
 268 \end_layout
 269
 270 \begin_layout Subsection*
 271 LFUN_ACCENT_UNDERDOT
 272 \end_layout
 273 \begin_layout Description
 274 Action Adds a dot under the next character typed.
 275 \end_layout
 276 \begin_layout Description
 277 Syntax accent-underdot
 278 \end_layout
 279
 280 \begin_layout Subsection*
 281 LFUN_ALL_CHANGES_ACCEPT
 282 \end_layout
 283 \begin_layout Description
 284 Action Accepts all tracked changes in the document.
 285 \end_layout
 286 \begin_layout Description
 287 Syntax all-changes-accept
 288 \end_layout
 289 \begin_layout Description
 290 Origin Levon, 16 Oct 2002
 291 \end_layout
 292
 293 \begin_layout Subsection*
 294 LFUN_ALL_CHANGES_REJECT
 295 \end_layout
 296 \begin_layout Description
 297 Action Rejects all tracked changes in the document.
 298 \end_layout
 299 \begin_layout Description
 300 Notion Reject does not work recursively; the user may have to repeat the operation.
 301 \end_layout
 302 \begin_layout Description
 303 Syntax all-changes-reject
 304 \end_layout
 305 \begin_layout Description
 306 Origin Levon, 16 Oct 2002
 307 \end_layout
 308
 309 \begin_layout Subsection*
 310 LFUN_APPENDIX
 311 \end_layout
 312 \begin_layout Description
 313 Action Start (or remove) Appendix on the given cursor position.
 314 \end_layout
 315 \begin_layout Description
 316 Syntax appendix
 317 \end_layout
 318 \begin_layout Description
 319 Origin ettrich, 5 May 1998
 320 \end_layout
 321
 322 \begin_layout Subsection*
 323 LFUN_ARGUMENT_INSERT
 324 \end_layout
 325 \begin_layout Description
 326 Action Inserts an argument (short title) inset.
 327 \end_layout
 328 \begin_layout Description
 329 Syntax argument-insert <argument nr>
 330 \end_layout
 331 \begin_layout Description
 332 Params <argument nr>: see layout declarations
 333 \end_layout
 334 \begin_layout Description
 335 Origin vermeer, 12 Aug 2002
 336 \end_layout
 337
 338 \begin_layout Subsection*
 339 LFUN_BIBTEX_DATABASE_ADD
 340 \end_layout
 341 \begin_layout Description
 342 Action Adds database, which will be used for bibtex citations.
 343 \end_layout
 344 \begin_layout Description
 345 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
 346 \end_layout
 347 \begin_layout Description
 348 Syntax bibtex-database-add <DATABASE-NAME>
 349 \end_layout
 350 \begin_layout Description
 351 Origin Ale, 30 May 1997
 352 \end_layout
 353
 354 \begin_layout Subsection*
 355 LFUN_BIBTEX_DATABASE_DEL
 356 \end_layout
 357 \begin_layout Description
 358 Action Adds database, which will be used for bibtex citations.
 359 \end_layout
 360 \begin_layout Description
 361 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor position.
 362 \end_layout
 363 \begin_layout Description
 364 Syntax bibtex-database-del <DATABASE-NAME>
 365 \end_layout
 366 \begin_layout Description
 367 Origin Ale, 30 May 1997
 368 \end_layout
 369
 370 \begin_layout Subsection*
 371 LFUN_BOOKMARK_CLEAR
 372 \end_layout
 373 \begin_layout Description
 374 Action Clears the list of saved bookmarks.
 375 \end_layout
 376 \begin_layout Description
 377 Syntax bookmark-clear
 378 \end_layout
 379 \begin_layout Description
 380 Origin bpeng, 31 October 2006
 381 \end_layout
 382
 383 \begin_layout Subsection*
 384 LFUN_BOOKMARK_GOTO
 385 \end_layout
 386 \begin_layout Description
 387 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarks are saved per-session, not per file.
 388 \end_layout
 389 \begin_layout Description
 390 Notion Bookmark 0 has a special purpose. It is automatically set
 391 \begin_inset Newline newline
 392 \end_inset
 393
 394 1. to the paragraph you are currently editing
 395 \begin_inset Newline newline
 396 \end_inset
 397
 398 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
 399 \begin_inset Newline newline
 400 \end_inset
 401
 402 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
 403 \end_layout
 404 \begin_layout Description
 405 Syntax bookmark-goto <NUMBER>
 406 \end_layout
 407 \begin_layout Description
 408 Params <NUMBER>: the number of the bookmark to restore.
 409 \end_layout
 410 \begin_layout Description
 411 Origin Dekel, 27 January 2001
 412 \end_layout
 413
 414 \begin_layout Subsection*
 415 LFUN_BOOKMARK_SAVE
 416 \end_layout
 417 \begin_layout Description
 418 Action Save a bookmark.
 419 \end_layout
 420 \begin_layout Description
 421 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.
 422 \end_layout
 423 \begin_layout Description
 424 Syntax bookmark-save <NUMBER>
 425 \end_layout
 426 \begin_layout Description
 427 Params <NUMBER>: the number of the bookmark to save.
 428 \end_layout
 429 \begin_layout Description
 430 Origin Dekel, 27 January 2001
 431 \end_layout
 432
 433 \begin_layout Subsection*
 434 LFUN_BOX_INSERT
 435 \end_layout
 436 \begin_layout Description
 437 Action Inserts Box inset.
 438 \end_layout
 439 \begin_layout Description
 440 Syntax box-insert [<TYPE>]
 441 \end_layout
 442 \begin_layout Description
 443 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
 444 \begin_inset Newline newline
 445 \end_inset
 446
 447 Framed is the default one.
 448 \end_layout
 449 \begin_layout Description
 450 Origin vermeer, 7 Oct 2003
 451 \end_layout
 452
 453 \begin_layout Subsection*
 454 LFUN_BRANCHES_RENAME
 455 \end_layout
 456 \begin_layout Description
 457 Action Rename all branches of a given name in a document.
 458 \end_layout
 459 \begin_layout Description
 460 Syntax branches-rename <OLDNAME> <NEWNAME>
 461 \end_layout
 462 \begin_layout Description
 463 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
 464 \end_layout
 465 \begin_layout Description
 466 Origin spitz, 9 Jul 2009
 467 \end_layout
 468
 469 \begin_layout Subsection*
 470 LFUN_BRANCH_ACTIVATE
 471 \end_layout
 472 \begin_layout Description
 473 Action Activate the branch.
 474 \end_layout
 475 \begin_layout Description
 476 Syntax branch-activate <BRANCH>
 477 \end_layout
 478 \begin_layout Description
 479 Params <BRANCH>: The branch to activate
 480 \end_layout
 481 \begin_layout Description
 482 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
 483 \begin_inset Newline newline
 484 \end_inset
 485
 486 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
 487 \end_layout
 488 \begin_layout Description
 489 Origin rgh, 27 May 2008
 490 \end_layout
 491
 492 \begin_layout Subsection*
 493 LFUN_BRANCH_ADD
 494 \end_layout
 495 \begin_layout Description
 496 Action Add a branch to the buffer's BranchList.
 497 \end_layout
 498 \begin_layout Description
 499 Syntax branch-add <BRANCH>
 500 \end_layout
 501 \begin_layout Description
 502 Params <BRANCH>: Name of the branch to add
 503 \end_layout
 504 \begin_layout Description
 505 Origin spitz, 7 Jul 2009
 506 \end_layout
 507
 508 \begin_layout Subsection*
 509 LFUN_BRANCH_ADD_INSERT
 510 \end_layout
 511 \begin_layout Description
 512 Action Create new branch and directly put the branch inset into the document.
 513 \end_layout
 514 \begin_layout Description
 515 Syntax branch-add-insert [<NAME>]
 516 \end_layout
 517 \begin_layout Description
 518 Params <NAME>: Branch name. If it is not specified, you will be asked.
 519 \end_layout
 520 \begin_layout Description
 521 Origin sanda, 10 Jul 2009
 522 \end_layout
 523
 524 \begin_layout Subsection*
 525 LFUN_BRANCH_DEACTIVATE
 526 \end_layout
 527 \begin_layout Description
 528 Action De-activate the branch.
 529 \end_layout
 530 \begin_layout Description
 531 Syntax branch-deactivate <BRANCH>
 532 \end_layout
 533 \begin_layout Description
 534 Params <BRANCH>: The branch to deactivate
 535 \end_layout
 536 \begin_layout Description
 537 Origin rgh, 27 May 2008
 538 \end_layout
 539
 540 \begin_layout Subsection*
 541 LFUN_BRANCH_INSERT
 542 \end_layout
 543 \begin_layout Description
 544 Action Inserts branch inset.
 545 \end_layout
 546 \begin_layout Description
 547 Syntax branch-insert <BRANCH-NAME>
 548 \end_layout
 549 \begin_layout Description
 550 Origin vermeer, 17 Aug 2003
 551 \end_layout
 552
 553 \begin_layout Subsection*
 554 LFUN_BRANCH_MASTER_ACTIVATE
 555 \end_layout
 556 \begin_layout Description
 557 Action Activate the branch in the master buffer.
 558 \end_layout
 559 \begin_layout Description
 560 Syntax branch-master-activate <BRANCH>
 561 \end_layout
 562 \begin_layout Description
 563 Params <BRANCH>: The branch to activate
 564 \end_layout
 565 \begin_layout Description
 566 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
 567 \begin_inset Newline newline
 568 \end_inset
 569
 570 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
 571 \end_layout
 572 \begin_layout Description
 573 Origin spitz, 30 Sep 2012
 574 \end_layout
 575
 576 \begin_layout Subsection*
 577 LFUN_BRANCH_MASTER_DEACTIVATE
 578 \end_layout
 579 \begin_layout Description
 580 Action De-activate the branch in the master buffer.
 581 \end_layout
 582 \begin_layout Description
 583 Syntax branch-master-deactivate <BRANCH>
 584 \end_layout
 585 \begin_layout Description
 586 Params <BRANCH>: The branch to deactivate
 587 \end_layout
 588 \begin_layout Description
 589 Origin spitz, 30 Sep 2012
 590 \end_layout
 591
 592 \begin_layout Subsection*
 593 LFUN_BUFFER_AUTO_SAVE
 594 \end_layout
 595 \begin_layout Description
 596 Action Saves the current buffer to a temporary file.
 597 \end_layout
 598 \begin_layout Description
 599 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
 600 \end_layout
 601 \begin_layout Description
 602 Syntax buffer-auto-save
 603 \end_layout
 604
 605 \begin_layout Subsection*
 606 LFUN_BUFFER_BEGIN
 607 \end_layout
 608 \begin_layout Description
 609 Action Move the cursor to the beginning of the document.
 610 \end_layout
 611 \begin_layout Description
 612 Syntax buffer-begin
 613 \end_layout
 614
 615 \begin_layout Subsection*
 616 LFUN_BUFFER_BEGIN_SELECT
 617 \end_layout
 618 \begin_layout Description
 619 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
 620 \end_layout
 621 \begin_layout Description
 622 Syntax buffer-begin-select
 623 \end_layout
 624
 625 \begin_layout Subsection*
 626 LFUN_BUFFER_CHILD_OPEN
 627 \end_layout
 628 \begin_layout Description
 629 Action Loads the given child document.
 630 \end_layout
 631 \begin_layout Description
 632 Notion The current document is treated as a parent.
 633 \end_layout
 634 \begin_layout Description
 635 Syntax buffer-child-open <FILE>
 636 \end_layout
 637 \begin_layout Description
 638 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
 639 \end_layout
 640 \begin_layout Description
 641 Origin Ale, 28 May 1997
 642 \end_layout
 643
 644 \begin_layout Subsection*
 645 LFUN_BUFFER_CHKTEX
 646 \end_layout
 647 \begin_layout Description
 648 Action Runs chktex for the current document.
 649 \end_layout
 650 \begin_layout Description
 651 Syntax buffer-chktex
 652 \end_layout
 653 \begin_layout Description
 654 Origin Asger, 30 Oct 1997
 655 \end_layout
 656
 657 \begin_layout Subsection*
 658 LFUN_BUFFER_CLOSE
 659 \end_layout
 660 \begin_layout Description
 661 Action Closes the current buffer.
 662 \end_layout
 663 \begin_layout Description
 664 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
 665 \end_layout
 666 \begin_layout Description
 667 Syntax buffer-close
 668 \end_layout
 669
 670 \begin_layout Subsection*
 671 LFUN_BUFFER_CLOSE_ALL
 672 \end_layout
 673 \begin_layout Description
 674 Action Closes all buffers.
 675 \end_layout
 676 \begin_layout Description
 677 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
 678 \end_layout
 679 \begin_layout Description
 680 Syntax buffer-close-all
 681 \end_layout
 682
 683 \begin_layout Subsection*
 684 LFUN_BUFFER_END
 685 \end_layout
 686 \begin_layout Description
 687 Action Move the cursor to the end of the document.
 688 \end_layout
 689 \begin_layout Description
 690 Syntax buffer-end
 691 \end_layout
 692
 693 \begin_layout Subsection*
 694 LFUN_BUFFER_END_SELECT
 695 \end_layout
 696 \begin_layout Description
 697 Action Move the cursor to the end of the document adding the traversed text to the selection.
 698 \end_layout
 699 \begin_layout Description
 700 Syntax buffer-end-select
 701 \end_layout
 702
 703 \begin_layout Subsection*
 704 LFUN_BUFFER_EXPORT
 705 \end_layout
 706 \begin_layout Description
 707 Action Exports the current buffer (document) to the given format.
 708 \end_layout
 709 \begin_layout Description
 710 Syntax buffer-export <FORMAT> [<DEST>]
 711 \end_layout
 712 \begin_layout Description
 713 Params <FORMAT> 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.
 714 \begin_inset Newline newline
 715 \end_inset
 716
 717 In case of "custom" you will be asked for a format you want to start from and for the command that you want to apply to this format. Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.                <DEST>  If present, this argument provides the export destination                       filename. Its containing folder will also be the destination                    folder, where all the needed external files will be copied.
 718 \end_layout
 719 \begin_layout Description
 720 Origin Lgb, 29 Jul 1997
 721 \end_layout
 722
 723 \begin_layout Subsection*
 724 LFUN_BUFFER_EXPORT_AS
 725 \end_layout
 726 \begin_layout Description
 727 Action Opens a dialog for exporting the current buffer.
 728 \end_layout
 729 \begin_layout Description
 730 Syntax buffer-export-as [<FORMAT>]
 731 \end_layout
 732 \begin_layout Description
 733 Params <FORMAT> 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.
 734 \end_layout
 735 \begin_layout Description
 736 Sample buffer-export-as pdf2
 737 \end_layout
 738 \begin_layout Description
 739 Origin tommaso, 6 Oct 2011
 740 \end_layout
 741
 742 \begin_layout Subsection*
 743 LFUN_BUFFER_EXPORT_CUSTOM
 744 \end_layout
 745 \begin_layout Description
 746 Action Exports the current buffer (document) from the given format using the given command on it.
 747 \end_layout
 748 \begin_layout Description
 749 Syntax buffer-export-custom <FORMAT> <COMMAND>
 750 \end_layout
 751 \begin_layout Description
 752 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
 753 \begin_inset Newline newline
 754 \end_inset
 755
 756 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
 757 \end_layout
 758 \begin_layout Description
 759 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
 760 \end_layout
 761 \begin_layout Description
 762 Origin leeming, 27 Mar 2004
 763 \end_layout
 764
 765 \begin_layout Subsection*
 766 LFUN_BUFFER_FORALL
 767 \end_layout
 768 \begin_layout Description
 769 Action Applies a command to all non-hidden buffers.
 770 \end_layout
 771 \begin_layout Description
 772 Notion a buffer is `hidden' if it is internally open in LyX, but not visible in any window.
 773 \end_layout
 774 \begin_layout Description
 775 Syntax buffer-forall <LFUN-COMMAND>
 776 \end_layout
 777 \begin_layout Description
 778 Params <LFUN-COMMAND>: The command to be applied to the buffers.
 779 \end_layout
 780 \begin_layout Description
 781 Sample Close all Notes in buffers:
 782 \begin_inset Newline newline
 783 \end_inset
 784
 785                    buffer-forall inset-forall Note inset-toggle close
 786 \begin_inset Newline newline
 787 \end_inset
 788
 789 Toggle change tracking on buffers:
 790 \begin_inset Newline newline
 791 \end_inset
 792
 793                    buffer-forall changes-track
 794 \begin_inset Newline newline
 795 \end_inset
 796
 797 Toggle read-only for buffers:
 798 \begin_inset Newline newline
 799 \end_inset
 800
 801                    buffer-forall buffer-toggle-read-only
 802 \begin_inset Newline newline
 803 \end_inset
 804
 805 Show statistics for individual buffers:
 806 \begin_inset Newline newline
 807 \end_inset
 808
 809                    buffer-forall statistics
 810 \begin_inset Newline newline
 811 \end_inset
 812
 813 Activate the branch named "Solutions" in buffers:
 814 \begin_inset Newline newline
 815 \end_inset
 816
 817                    buffer-forall branch-activate Solutions
 818 \begin_inset Newline newline
 819 \end_inset
 820
 821 Export buffers to PDF (pdflatex):
 822 \begin_inset Newline newline
 823 \end_inset
 824
 825                    buffer-forall buffer-export pdf2
 826 \begin_inset Newline newline
 827 \end_inset
 828
 829
 830 \end_layout
 831 \begin_layout Description
 832 Origin scottkostyshak, 20 Jul 2012
 833 \end_layout
 834
 835 \begin_layout Subsection*
 836 LFUN_BUFFER_IMPORT
 837 \end_layout
 838 \begin_layout Description
 839 Action Import a given file as a lyx document.
 840 \end_layout
 841 \begin_layout Description
 842 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.
 843 \end_layout
 844 \begin_layout Description
 845 Syntax buffer-import <FORMAT> [<FILE>]
 846 \end_layout
 847 \begin_layout Description
 848 Origin Asger, 24 Jul 1998
 849 \end_layout
 850
 851 \begin_layout Subsection*
 852 LFUN_BUFFER_LANGUAGE
 853 \end_layout
 854 \begin_layout Description
 855 Action Set language of the current document.
 856 \end_layout
 857 \begin_layout Description
 858 Syntax buffer-language <LANG>
 859 \end_layout
 860 \begin_layout Description
 861 Params <LANG>: language name. See lib/languages for list.
 862 \end_layout
 863 \begin_layout Description
 864 Origin leeming, 30 Mar 2004
 865 \end_layout
 866
 867 \begin_layout Subsection*
 868 LFUN_BUFFER_NEW
 869 \end_layout
 870 \begin_layout Description
 871 Action Creates a new buffer (that is, document) and switches to it.
 872 \end_layout
 873 \begin_layout Description
 874 Notion Implicit path can be set in Preferences dialog.
 875 \end_layout
 876 \begin_layout Description
 877 Syntax buffer-new [<FILE>]
 878 \end_layout
 879 \begin_layout Description
 880 Params <FILE>: filename of created file with absolute path.
 881 \end_layout
 882
 883 \begin_layout Subsection*
 884 LFUN_BUFFER_NEW_TEMPLATE
 885 \end_layout
 886 \begin_layout Description
 887 Action Creates a new buffer (that is, document) from a template.
 888 \end_layout
 889 \begin_layout Description
 890 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
 891 \end_layout
 892 \begin_layout Description
 893 Syntax buffer-new-template [<FILE>]
 894 \end_layout
 895 \begin_layout Description
 896 Params <FILE>: filename of created file with absolute path.
 897 \end_layout
 898
 899 \begin_layout Subsection*
 900 LFUN_BUFFER_NEXT
 901 \end_layout
 902 \begin_layout Description
 903 Action Switch to the next opened document.
 904 \end_layout
 905 \begin_layout Description
 906 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
 907 \end_layout
 908 \begin_layout Description
 909 Syntax buffer-next
 910 \end_layout
 911
 912 \begin_layout Subsection*
 913 LFUN_BUFFER_PARAMS_APPLY
 914 \end_layout
 915 \begin_layout Description
 916 Action Apply the given settings to the current document.
 917 \end_layout
 918 \begin_layout Description
 919 Syntax buffer-params-apply [<ARGS>]
 920 \end_layout
 921 \begin_layout Description
 922 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
 923 \end_layout
 924 \begin_layout Description
 925 Origin leeming, 30 Mar 2004
 926 \end_layout
 927
 928 \begin_layout Subsection*
 929 LFUN_BUFFER_PREVIOUS
 930 \end_layout
 931 \begin_layout Description
 932 Action Switch to the previous opened document.
 933 \end_layout
 934 \begin_layout Description
 935 Syntax buffer-previous
 936 \end_layout
 937
 938 \begin_layout Subsection*
 939 LFUN_BUFFER_PRINT
 940 \end_layout
 941 \begin_layout Description
 942 Action Prints the current document.
 943 \end_layout
 944 \begin_layout Description
 945 Notion Many settings can be given via the preferences dialog.
 946 \end_layout
 947 \begin_layout Description
 948 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
 949 \end_layout
 950 \begin_layout Description
 951 Params <TARGET> is either "printer" or "file".
 952 \begin_inset Newline newline
 953 \end_inset
 954
 955 <TARGER-NAME> is either "default" or file name or printer name.
 956 \begin_inset Newline newline
 957 \end_inset
 958
 959 <COMMAND> command ensuring the printing job.
 960 \end_layout
 961 \begin_layout Description
 962 Sample buffer-print file "/trash/newfile1.ps" "dvips"
 963 \end_layout
 964 \begin_layout Description
 965 Origin leeming, 28 Mar 2004
 966 \end_layout
 967
 968 \begin_layout Subsection*
 969 LFUN_BUFFER_RELOAD
 970 \end_layout
 971 \begin_layout Description
 972 Action Reverts opened document.
 973 \end_layout
 974 \begin_layout Description
 975 Syntax buffer-reload
 976 \end_layout
 977 \begin_layout Description
 978 Origin Asger, 2 Feb 1997
 979 \end_layout
 980
 981 \begin_layout Subsection*
 982 LFUN_BUFFER_SAVE_AS_DEFAULT
 983 \end_layout
 984 \begin_layout Description
 985 Action Save the current document settings as default.
 986 \end_layout
 987 \begin_layout Description
 988 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
 989 \end_layout
 990 \begin_layout Description
 991 Syntax buffer-save-as-default [<ARGS>]
 992 \end_layout
 993 \begin_layout Description
 994 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
 995 \end_layout
 996 \begin_layout Description
 997 Origin leeming, 30 Mar 2004
 998 \end_layout
 999
1000 \begin_layout Subsection*
1001 LFUN_BUFFER_SWITCH
1002 \end_layout
1003 \begin_layout Description
1004 Action Display and switch to the given buffer.
1005 \end_layout
1006 \begin_layout Description
1007 Syntax buffer-switch <BUFFER>
1008 \end_layout
1009 \begin_layout Description
1010 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
1011 \end_layout
1012
1013 \begin_layout Subsection*
1014 LFUN_BUFFER_TOGGLE_COMPRESSION
1015 \end_layout
1016 \begin_layout Description
1017 Action Toggles compression of the current document on/off.
1018 \end_layout
1019 \begin_layout Description
1020 Syntax buffer-toggle-compression
1021 \end_layout
1022 \begin_layout Description
1023 Origin bpeng, 27 Apr 2006
1024 \end_layout
1025
1026 \begin_layout Subsection*
1027 LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
1028 \end_layout
1029 \begin_layout Description
1030 Action Toggles including of resources for forward/reverse search of the given document.
1031 \end_layout
1032 \begin_layout Description
1033 Notion When toggled on, SyncTeX is invoked for PDF, while srcltx package is used for DVI. Custom LaTeX macro can be defined in preferences.
1034 \end_layout
1035 \begin_layout Description
1036 Syntax buffer-toggle-output-sync
1037 \end_layout
1038 \begin_layout Description
1039 Origin sanda, 25 May 2010
1040 \end_layout
1041
1042 \begin_layout Subsection*
1043 LFUN_BUFFER_TOGGLE_READ_ONLY
1044 \end_layout
1045 \begin_layout Description
1046 Action Toggle editing mode of the current document between read/write and read-only.
1047 \end_layout
1048 \begin_layout Description
1049 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.
1050 \end_layout
1051 \begin_layout Description
1052 Syntax buffer-toggle-read-only
1053 \end_layout
1054 \begin_layout Description
1055 Origin Lgb, 27 May 1997
1056 \end_layout
1057
1058 \begin_layout Subsection*
1059 LFUN_BUFFER_UPDATE
1060 \end_layout
1061 \begin_layout Description
1062 Action Exports the current document and put the result into the temporary directory.
1063 \end_layout
1064 \begin_layout Description
1065 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).
1066 \end_layout
1067 \begin_layout Description
1068 Syntax buffer-update [<FORMAT>]
1069 \end_layout
1070 \begin_layout Description
1071 Params <FORMAT>: 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.
1072 \end_layout
1073 \begin_layout Description
1074 Origin Dekel, 5 Aug 2000
1075 \end_layout
1076
1077 \begin_layout Subsection*
1078 LFUN_BUFFER_VIEW
1079 \end_layout
1080 \begin_layout Description
1081 Action Displays current buffer in chosen format.
1082 \end_layout
1083 \begin_layout Description
1084 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.
1085 \end_layout
1086 \begin_layout Description
1087 Syntax buffer-view [<FORMAT>]
1088 \end_layout
1089 \begin_layout Description
1090 Params <FORMAT>: 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.
1091 \end_layout
1092
1093 \begin_layout Subsection*
1094 LFUN_BUFFER_WRITE
1095 \end_layout
1096 \begin_layout Description
1097 Action Saves the current buffer.
1098 \end_layout
1099 \begin_layout Description
1100 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.
1101 \end_layout
1102 \begin_layout Description
1103 Syntax buffer-write
1104 \end_layout
1105
1106 \begin_layout Subsection*
1107 LFUN_BUFFER_WRITE_ALL
1108 \end_layout
1109 \begin_layout Description
1110 Action Save all changed documents.
1111 \end_layout
1112 \begin_layout Description
1113 Syntax buffer-write-all
1114 \end_layout
1115 \begin_layout Description
1116 Origin rgh, gpothier 6 Aug 2007
1117 \end_layout
1118
1119 \begin_layout Subsection*
1120 LFUN_BUFFER_WRITE_AS
1121 \end_layout
1122 \begin_layout Description
1123 Action Rename and save current buffer.
1124 \end_layout
1125 \begin_layout Description
1126 Syntax buffer-write-as <FILENAME>
1127 \end_layout
1128 \begin_layout Description
1129 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
1130 \end_layout
1131
1132 \begin_layout Subsection*
1133 LFUN_BUFFER_ZOOM_IN
1134 \end_layout
1135 \begin_layout Description
1136 Action Increases the zoom of the screen fonts.
1137 \end_layout
1138 \begin_layout Description
1139 Syntax buffer-zoom-in [<ZOOM>]
1140 \end_layout
1141 \begin_layout Description
1142 Params <ZOOM>: The zoom in %, the default is 20.
1143 \end_layout
1144 \begin_layout Description
1145 Origin vfr, 30 Mar 2009
1146 \end_layout
1147
1148 \begin_layout Subsection*
1149 LFUN_BUFFER_ZOOM_OUT
1150 \end_layout
1151 \begin_layout Description
1152 Action Decreases the zoom of the screen fonts.
1153 \end_layout
1154 \begin_layout Description
1155 Syntax buffer-zoom-out [<ZOOM>]
1156 \end_layout
1157 \begin_layout Description
1158 Params <ZOOM>: The zoom in %, the default is 20.
1159 \end_layout
1160 \begin_layout Description
1161 Origin vfr, 30 Mar 2009
1162 \end_layout
1163
1164 \begin_layout Subsection*
1165 LFUN_BUILD_PROGRAM
1166 \end_layout
1167 \begin_layout Description
1168 Action Generates the code (literate programming).
1169 \end_layout
1170 \begin_layout Description
1171 Notion Latex file with extension
1172 \backslash
1173 literate_extension is generated. Then LyX invokes
1174 \backslash
1175 build_command (with a default of ``make'') to generate the code and
1176 \backslash
1177 build_error_filter to process the compilation error messages.
1178 \begin_inset Newline newline
1179 \end_inset
1180
1181 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:
1182 \begin_inset Newline newline
1183 \end_inset
1184
1185
1186 \backslash
1187 build_command "my_script my_arguments"
1188 \begin_inset Newline newline
1189 \end_inset
1190
1191 The
1192 \backslash
1193 build_error_filter differs from the
1194 \backslash
1195 literate_error_filter only in that the former will identify error messages from your compiler.
1196 \end_layout
1197 \begin_layout Description
1198 Syntax build-program
1199 \end_layout
1200
1201 \begin_layout Subsection*
1202 LFUN_CALL
1203 \end_layout
1204 \begin_layout Description
1205 Action Executes a command defined in a .def file.
1206 \end_layout
1207 \begin_layout Description
1208 Notion The definitions are by default read from lib/commands/default.def.
1209 \begin_inset Newline newline
1210 \end_inset
1211
1212 A .def file allows to define a command with
1213 \backslash
1214 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and <LFUN> is the lfun code to be executed (see e.g. LFUN_COMMAND_SEQUENCE).
1215 \backslash
1216 def_file "FileName" allows to include another .def file.
1217 \begin_inset Newline newline
1218 \end_inset
1219
1220 This is particularly useful in connection with toolbar buttons: Since the name of the button image for this lfun is lib/images/commands/<NAME>.png this is the way to assign an image to a complex command-sequence.
1221 \end_layout
1222 \begin_layout Description
1223 Syntax call <NAME>
1224 \end_layout
1225 \begin_layout Description
1226 Params <NAME>: Name of the command that must be called.
1227 \end_layout
1228 \begin_layout Description
1229 Origin broider, 2 Oct 2007
1230 \end_layout
1231
1232 \begin_layout Subsection*
1233 LFUN_CANCEL
1234 \end_layout
1235 \begin_layout Description
1236 Action Cancels sequence prepared by LFUN_META_PREFIX .
1237 \end_layout
1238 \begin_layout Description
1239 Syntax cancel
1240 \end_layout
1241
1242 \begin_layout Subsection*
1243 LFUN_CAPTION_INSERT
1244 \end_layout
1245 \begin_layout Description
1246 Action Inserts a caption inset.
1247 \end_layout
1248 \begin_layout Description
1249 Syntax caption-insert
1250 \end_layout
1251 \begin_layout Description
1252 Origin Lgb, 18 Jul 2000
1253 \end_layout
1254
1255 \begin_layout Subsection*
1256 LFUN_CELL_BACKWARD
1257 \end_layout
1258 \begin_layout Description
1259 Action Moves the cursor to the previous cell inside the table.
1260 \end_layout
1261 \begin_layout Description
1262 Syntax cell-backward
1263 \end_layout
1264 \begin_layout Description
1265 Origin Jug, 22 May 2000
1266 \end_layout
1267
1268 \begin_layout Subsection*
1269 LFUN_CELL_FORWARD
1270 \end_layout
1271 \begin_layout Description
1272 Action Moves the cursor to the next cell inside the table.
1273 \end_layout
1274 \begin_layout Description
1275 Syntax cell-forward
1276 \end_layout
1277
1278 \begin_layout Subsection*
1279 LFUN_CELL_SPLIT
1280 \end_layout
1281 \begin_layout Description
1282 Action Splits cell and shifts right part to the next cell (inside the math grid).
1283 \end_layout
1284 \begin_layout Description
1285 Syntax cell-split
1286 \end_layout
1287 \begin_layout Description
1288 Origin Ale, 15 May 1997
1289 \end_layout
1290
1291 \begin_layout Subsection*
1292 LFUN_CHANGES_MERGE
1293 \end_layout
1294 \begin_layout Description
1295 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
1296 \end_layout
1297 \begin_layout Description
1298 Syntax changes-merge
1299 \end_layout
1300 \begin_layout Description
1301 Origin Levon, 16 Oct 2002
1302 \end_layout
1303
1304 \begin_layout Subsection*
1305 LFUN_CHANGES_OUTPUT
1306 \end_layout
1307 \begin_layout Description
1308 Action Toggles showing of change tracking in typesetted output.
1309 \end_layout
1310 \begin_layout Description
1311 Syntax changes-output
1312 \end_layout
1313 \begin_layout Description
1314 Origin jspitzm, 21 Jan 2005
1315 \end_layout
1316
1317 \begin_layout Subsection*
1318 LFUN_CHANGES_TRACK
1319 \end_layout
1320 \begin_layout Description
1321 Action Toggles change tracking to on/off.
1322 \end_layout
1323 \begin_layout Description
1324 Syntax changes-track
1325 \end_layout
1326 \begin_layout Description
1327 Origin levon, 1 Oct 2002
1328 \end_layout
1329
1330 \begin_layout Subsection*
1331 LFUN_CHANGE_ACCEPT
1332 \end_layout
1333 \begin_layout Description
1334 Action Accepts tracked change inside the selection.
1335 \end_layout
1336 \begin_layout Description
1337 Syntax change-accept
1338 \end_layout
1339 \begin_layout Description
1340 Origin Levon, 16 Oct 2002
1341 \end_layout
1342
1343 \begin_layout Subsection*
1344 LFUN_CHANGE_NEXT
1345 \end_layout
1346 \begin_layout Description
1347 Action Moves the cursor to the position of the next change of the change tracking records.
1348 \end_layout
1349 \begin_layout Description
1350 Syntax change-next
1351 \end_layout
1352 \begin_layout Description
1353 Origin schmitt, 4 Oct 2006
1354 \end_layout
1355
1356 \begin_layout Subsection*
1357 LFUN_CHANGE_PREVIOUS
1358 \end_layout
1359 \begin_layout Description
1360 Action Moves the cursor to the position of the previous change of the change tracking records.
1361 \end_layout
1362 \begin_layout Description
1363 Syntax change-previous
1364 \end_layout
1365 \begin_layout Description
1366 Origin vfr, 4 Apr 2009
1367 \end_layout
1368
1369 \begin_layout Subsection*
1370 LFUN_CHANGE_REJECT
1371 \end_layout
1372 \begin_layout Description
1373 Action Rejects tracked change inside the selection.
1374 \end_layout
1375 \begin_layout Description
1376 Syntax change-reject
1377 \end_layout
1378 \begin_layout Description
1379 Origin Levon, 16 Oct 2002
1380 \end_layout
1381
1382 \begin_layout Subsection*
1383 LFUN_CHARS_TRANSPOSE
1384 \end_layout
1385 \begin_layout Description
1386 Action Transposes the character at the cursor with the one before it.
1387 \end_layout
1388 \begin_layout Description
1389 Syntax chars-transpose
1390 \end_layout
1391 \begin_layout Description
1392 Origin Lgb, 25 Apr 2001
1393 \end_layout
1394
1395 \begin_layout Subsection*
1396 LFUN_CHAR_BACKWARD
1397 \end_layout
1398 \begin_layout Description
1399 Action Moves the cursor one position logically backwards.
1400 \end_layout
1401 \begin_layout Description
1402 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.
1403 \end_layout
1404 \begin_layout Description
1405 Syntax char-backward
1406 \end_layout
1407
1408 \begin_layout Subsection*
1409 LFUN_CHAR_BACKWARD_SELECT
1410 \end_layout
1411 \begin_layout Description
1412 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1413 \end_layout
1414 \begin_layout Description
1415 Notion See also LFUN_CHAR_BACKWARD.
1416 \end_layout
1417 \begin_layout Description
1418 Syntax char-backward-select
1419 \end_layout
1420
1421 \begin_layout Subsection*
1422 LFUN_CHAR_DELETE_BACKWARD
1423 \end_layout
1424 \begin_layout Description
1425 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1426 \end_layout
1427 \begin_layout Description
1428 Syntax char-delete-backward
1429 \end_layout
1430
1431 \begin_layout Subsection*
1432 LFUN_CHAR_DELETE_FORWARD
1433 \end_layout
1434 \begin_layout Description
1435 Action Deletes one character in the backward direction (usually the "Delete" key).
1436 \end_layout
1437 \begin_layout Description
1438 Syntax char-delete-forward
1439 \end_layout
1440
1441 \begin_layout Subsection*
1442 LFUN_CHAR_FORWARD
1443 \end_layout
1444 \begin_layout Description
1445 Action Moves the cursor one position logically forward.
1446 \end_layout
1447 \begin_layout Description
1448 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.
1449 \end_layout
1450 \begin_layout Description
1451 Syntax char-forward
1452 \end_layout
1453
1454 \begin_layout Subsection*
1455 LFUN_CHAR_FORWARD_SELECT
1456 \end_layout
1457 \begin_layout Description
1458 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1459 \end_layout
1460 \begin_layout Description
1461 Notion See also LFUN_CHAR_FORWARD.
1462 \end_layout
1463 \begin_layout Description
1464 Syntax char-forward-select
1465 \end_layout
1466
1467 \begin_layout Subsection*
1468 LFUN_CHAR_LEFT
1469 \end_layout
1470 \begin_layout Description
1471 Action Moves the cursor one position "to the left".
1472 \end_layout
1473 \begin_layout Description
1474 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.
1475 \end_layout
1476 \begin_layout Description
1477 Syntax char-left
1478 \end_layout
1479
1480 \begin_layout Subsection*
1481 LFUN_CHAR_LEFT_SELECT
1482 \end_layout
1483 \begin_layout Description
1484 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1485 \end_layout
1486 \begin_layout Description
1487 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1488 \end_layout
1489 \begin_layout Description
1490 Syntax char-left-select
1491 \end_layout
1492
1493 \begin_layout Subsection*
1494 LFUN_CHAR_RIGHT
1495 \end_layout
1496 \begin_layout Description
1497 Action Moves the cursor one position "to the right".
1498 \end_layout
1499 \begin_layout Description
1500 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.
1501 \end_layout
1502 \begin_layout Description
1503 Syntax char-right
1504 \end_layout
1505
1506 \begin_layout Subsection*
1507 LFUN_CHAR_RIGHT_SELECT
1508 \end_layout
1509 \begin_layout Description
1510 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1511 \end_layout
1512 \begin_layout Description
1513 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1514 \end_layout
1515 \begin_layout Description
1516 Syntax char-right-select
1517 \end_layout
1518
1519 \begin_layout Subsection*
1520 LFUN_CITATION_INSERT
1521 \end_layout
1522 \begin_layout Description
1523 Action Inserts citation from loaded citation database.
1524 \end_layout
1525 \begin_layout Description
1526 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1527 \end_layout
1528 \begin_layout Description
1529 Params <KEY>: Citation (shortcut listed in available citations).
1530 \begin_inset Newline newline
1531 \end_inset
1532
1533 <TEXT_BEFORE>: text which should appear before citation.
1534 \end_layout
1535 \begin_layout Description
1536 Origin AAS, 97-02-23
1537 \end_layout
1538
1539 \begin_layout Subsection*
1540 LFUN_CLIPBOARD_PASTE
1541 \end_layout
1542 \begin_layout Description
1543 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.
1544 \end_layout
1545 \begin_layout Description
1546 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.
1547 \end_layout
1548 \begin_layout Description
1549 Syntax clipboard-paste [<ARG>]
1550 \end_layout
1551 \begin_layout Description
1552 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1553 \end_layout
1554 \begin_layout Description
1555 Origin Georg, 10 Jul 2006
1556 \end_layout
1557
1558 \begin_layout Subsection*
1559 LFUN_CLIPBOARD_PASTE_SIMPLE
1560 \end_layout
1561 \begin_layout Description
1562 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.
1563 \end_layout
1564 \begin_layout Description
1565 Syntax clipboard-paste-simple [<ARG>]
1566 \end_layout
1567 \begin_layout Description
1568 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1569 \end_layout
1570
1571 \begin_layout Subsection*
1572 LFUN_COMMAND_ALTERNATIVES
1573 \end_layout
1574 \begin_layout Description
1575 Action Runs the first listed command that is enabled.
1576 \end_layout
1577 \begin_layout Description
1578 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
1579 \end_layout
1580 \begin_layout Description
1581 Syntax command-alternatives <CMDS>
1582 \end_layout
1583 \begin_layout Description
1584 Params <CMDS>: Sequence of commands separated by semicolons.
1585 \end_layout
1586 \begin_layout Description
1587 Sample command-alternatives completion-accept;cell-forward
1588 \end_layout
1589 \begin_layout Description
1590 Origin rgh, 24 September 2008
1591 \end_layout
1592
1593 \begin_layout Subsection*
1594 LFUN_COMMAND_EXECUTE
1595 \end_layout
1596 \begin_layout Description
1597 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
1598 \end_layout
1599 \begin_layout Description
1600 Notion Usually bound to M-x shortcut.
1601 \end_layout
1602 \begin_layout Description
1603 Syntax command-execute
1604 \end_layout
1605
1606 \begin_layout Subsection*
1607 LFUN_COMMAND_PREFIX
1608 \end_layout
1609 \begin_layout Description
1610 Action Return the current key sequence and available options as a string.
1611 \end_layout
1612 \begin_layout Description
1613 Notion No options are added if no current map exists.
1614 \begin_inset Newline newline
1615 \end_inset
1616
1617 This is probably usable only with connection to lyxserver.
1618 \end_layout
1619 \begin_layout Description
1620 Syntax command-prefix
1621 \end_layout
1622
1623 \begin_layout Subsection*
1624 LFUN_COMMAND_SEQUENCE
1625 \end_layout
1626 \begin_layout Description
1627 Action Run more commands (LFUN and its parameters) in a sequence.
1628 \end_layout
1629 \begin_layout Description
1630 Syntax command-sequence <CMDS>
1631 \end_layout
1632 \begin_layout Description
1633 Params <CMDS>: Sequence of commands separated by semicolons.
1634 \end_layout
1635 \begin_layout Description
1636 Sample command-sequence cut; ert-insert; self-insert
1637 \backslash
1638 ; paste; self-insert {}; inset-toggle;
1639 \end_layout
1640 \begin_layout Description
1641 Origin Andre, 11 Nov 1999
1642 \end_layout
1643
1644 \begin_layout Subsection*
1645 LFUN_COMPLETION_ACCEPT
1646 \end_layout
1647 \begin_layout Description
1648 Action Accept suggested completion.
1649 \end_layout
1650 \begin_layout Description
1651 Syntax completion-accept
1652 \end_layout
1653 \begin_layout Description
1654 Origin sanda, Sep 08 2008
1655 \end_layout
1656
1657 \begin_layout Subsection*
1658 LFUN_COMPLETION_CANCEL
1659 \end_layout
1660 \begin_layout Description
1661 Action Try to cancel completion, either the popup or the inline completion.
1662 \end_layout
1663 \begin_layout Description
1664 Syntax completion-cancel
1665 \end_layout
1666 \begin_layout Description
1667 Origin sts, Sep 07 2008
1668 \end_layout
1669
1670 \begin_layout Subsection*
1671 LFUN_COMPLETION_COMPLETE
1672 \end_layout
1673 \begin_layout Description
1674 Action Try to complete the word or command at the cursor position.
1675 \end_layout
1676 \begin_layout Description
1677 Syntax complete
1678 \end_layout
1679 \begin_layout Description
1680 Origin sts, Feb 19 2008
1681 \end_layout
1682
1683 \begin_layout Subsection*
1684 LFUN_COMPLETION_INLINE
1685 \end_layout
1686 \begin_layout Description
1687 Action Show the inline completion at the cursor position.
1688 \end_layout
1689 \begin_layout Description
1690 Syntax completion-inline
1691 \end_layout
1692 \begin_layout Description
1693 Origin sts, Feb 19 2008
1694 \end_layout
1695
1696 \begin_layout Subsection*
1697 LFUN_COMPLETION_POPUP
1698 \end_layout
1699 \begin_layout Description
1700 Action Show the completion popup at the cursor position.
1701 \end_layout
1702 \begin_layout Description
1703 Syntax completion-popup
1704 \end_layout
1705 \begin_layout Description
1706 Origin sts, Feb 19 2008
1707 \end_layout
1708
1709 \begin_layout Subsection*
1710 LFUN_COPY
1711 \end_layout
1712 \begin_layout Description
1713 Action Copies the current selection to the clipboard.
1714 \end_layout
1715 \begin_layout Description
1716 Syntax copy
1717 \end_layout
1718
1719 \begin_layout Subsection*
1720 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1721 \end_layout
1722 \begin_layout Description
1723 Action Determine whether to keep cursor inside the editing window regardless of the scrollbar movement.
1724 \end_layout
1725 \begin_layout Description
1726 Syntax toggle-cursor-follows-scrollbar
1727 \end_layout
1728 \begin_layout Description
1729 Origin ARRae, 2 Dec 1997
1730 \end_layout
1731
1732 \begin_layout Subsection*
1733 LFUN_CUT
1734 \end_layout
1735 \begin_layout Description
1736 Action Cuts to the clipboard.
1737 \end_layout
1738 \begin_layout Description
1739 Syntax cut
1740 \end_layout
1741
1742 \begin_layout Subsection*
1743 LFUN_DATE_INSERT
1744 \end_layout
1745 \begin_layout Description
1746 Action Inserts the current date.
1747 \end_layout
1748 \begin_layout Description
1749 Syntax date-insert [<ARG>]
1750 \end_layout
1751 \begin_layout Description
1752 Params <ARG>: Format of date. The default value (%x) can be set in Preferences->Date format. For possible formats see manual page of strftime function.
1753 \end_layout
1754 \begin_layout Description
1755 Origin jdblair, 31 Jan 2000
1756 \end_layout
1757
1758 \begin_layout Subsection*
1759 LFUN_DEBUG_LEVEL_SET
1760 \end_layout
1761 \begin_layout Description
1762 Action Set debug output level.
1763 \end_layout
1764 \begin_layout Description
1765 Syntax debug-level-set <LEVEL>
1766 \end_layout
1767 \begin_layout Description
1768 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
1769 \end_layout
1770 \begin_layout Description
1771 Origin sanda, 28 Dec 2009
1772 \end_layout
1773
1774 \begin_layout Subsection*
1775 LFUN_DEPTH_DECREMENT
1776 \end_layout
1777 \begin_layout Description
1778 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1779 \end_layout
1780 \begin_layout Description
1781 Syntax depth-decrement
1782 \end_layout
1783
1784 \begin_layout Subsection*
1785 LFUN_DEPTH_INCREMENT
1786 \end_layout
1787 \begin_layout Description
1788 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1789 \end_layout
1790 \begin_layout Description
1791 Syntax depth-increment
1792 \end_layout
1793
1794 \begin_layout Subsection*
1795 LFUN_DIALOG_DISCONNECT_INSET
1796 \end_layout
1797 \begin_layout Description
1798 Action Closes opened connection to opened inset.
1799 \end_layout
1800 \begin_layout Description
1801 Notion Connection is used for apply functions.
1802 \end_layout
1803 \begin_layout Description
1804 Syntax dialog-disconnect-inset <INSET-NAME>
1805 \end_layout
1806 \begin_layout Description
1807 Origin leeming, 25 Feb 2003
1808 \end_layout
1809
1810 \begin_layout Subsection*
1811 LFUN_DIALOG_HIDE
1812 \end_layout
1813 \begin_layout Description
1814 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
1815 \end_layout
1816 \begin_layout Description
1817 Syntax dialog-hide <NAME>
1818 \end_layout
1819 \begin_layout Description
1820 Params See LFUN_DIALOG_SHOW .
1821 \end_layout
1822 \begin_layout Description
1823 Origin leeming, 25 Feb 2003
1824 \end_layout
1825
1826 \begin_layout Subsection*
1827 LFUN_DIALOG_SHOW
1828 \end_layout
1829 \begin_layout Description
1830 Action Shows hidden dialog or creates new one for a given function/inset settings etc.
1831 \end_layout
1832 \begin_layout Description
1833 Syntax dialog-show <NAME> [<DATA>]
1834 \end_layout
1835 \begin_layout Description
1836 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
1837 \begin_inset Newline newline
1838 \end_inset
1839
1840 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
1841 \begin_inset Newline newline
1842 \end_inset
1843
1844 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|
1845 \begin_inset Newline newline
1846 \end_inset
1847
1848 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
1849 \begin_inset Newline newline
1850 \end_inset
1851
1852 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
1853 \begin_inset Newline newline
1854 \end_inset
1855
1856 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
1857 \begin_inset Newline newline
1858 \end_inset
1859
1860 <SPECIAL>: latexlog|vclog
1861 \begin_inset Newline newline
1862 \end_inset
1863
1864 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
1865 \end_layout
1866 \begin_layout Description
1867 Origin leeming, 17 Jun 2003
1868 \end_layout
1869
1870 \begin_layout Subsection*
1871 LFUN_DIALOG_SHOW_NEW_INSET
1872 \end_layout
1873 \begin_layout Description
1874 Action Shows hidden dialog or create new one for a given inset settings etc.
1875 \end_layout
1876 \begin_layout Description
1877 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
1878 \end_layout
1879 \begin_layout Description
1880 Syntax dialog-show-new-inset <NAME> [<DATA>]
1881 \end_layout
1882 \begin_layout Description
1883 Params See LFUN_DIALOG_SHOW .
1884 \end_layout
1885 \begin_layout Description
1886 Origin leeming, 25 Feb 2003
1887 \end_layout
1888
1889 \begin_layout Subsection*
1890 LFUN_DIALOG_TOGGLE
1891 \end_layout
1892 \begin_layout Description
1893 Action Toggles dialog between showed/hidden state.
1894 \end_layout
1895 \begin_layout Description
1896 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
1897 \end_layout
1898 \begin_layout Description
1899 Syntax dialog-toggle <NAME> [<DATA>]
1900 \end_layout
1901 \begin_layout Description
1902 Params See LFUN_DIALOG_SHOW .
1903 \end_layout
1904 \begin_layout Description
1905 Origin JSpitzm, 30 Apr 2007
1906 \end_layout
1907
1908 \begin_layout Subsection*
1909 LFUN_DIALOG_UPDATE
1910 \end_layout
1911 \begin_layout Description
1912 Action Updates the dialog values from the inset/paragraph/document.
1913 \end_layout
1914 \begin_layout Description
1915 Syntax dialog-update <NAME>
1916 \end_layout
1917 \begin_layout Description
1918 Params <NAME>: paragraph|prefs|<INSET>
1919 \begin_inset Newline newline
1920 \end_inset
1921
1922 <INSET>: inset name
1923 \end_layout
1924 \begin_layout Description
1925 Origin leeming, 25 Feb 2003
1926 \end_layout
1927
1928 \begin_layout Subsection*
1929 LFUN_DOWN
1930 \end_layout
1931 \begin_layout Description
1932 Action Moves the cursor one line in downward direction.
1933 \end_layout
1934 \begin_layout Description
1935 Syntax down
1936 \end_layout
1937
1938 \begin_layout Subsection*
1939 LFUN_DOWN_SELECT
1940 \end_layout
1941 \begin_layout Description
1942 Action Moves the cursor one line in downward direction adding the current position to the selection.
1943 \end_layout
1944 \begin_layout Description
1945 Syntax down-select
1946 \end_layout
1947
1948 \begin_layout Subsection*
1949 LFUN_DROP_LAYOUTS_CHOICE
1950 \end_layout
1951 \begin_layout Description
1952 Action Displays list of layout choices.
1953 \end_layout
1954 \begin_layout Description
1955 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
1956 \end_layout
1957 \begin_layout Description
1958 Syntax drop-layouts-choice
1959 \end_layout
1960
1961 \begin_layout Subsection*
1962 LFUN_ENVIRONMENT_SPLIT
1963 \end_layout
1964 \begin_layout Description
1965 Action Splits the current environment with a Separator.
1966 \end_layout
1967 \begin_layout Description
1968 Syntax environment-split [outer]
1969 \end_layout
1970 \begin_layout Description
1971 Params outer: If this is given, LyX will split the outermost environment in the current nesting hierarchy.
1972 \end_layout
1973 \begin_layout Description
1974 Origin spitz, 23 Dec 2012
1975 \end_layout
1976
1977 \begin_layout Subsection*
1978 LFUN_ERT_INSERT
1979 \end_layout
1980 \begin_layout Description
1981 Action Inserts an ERT inset.
1982 \end_layout
1983 \begin_layout Description
1984 Syntax ert-insert
1985 \end_layout
1986 \begin_layout Description
1987 Origin Jug, 18 Feb 2000
1988 \end_layout
1989
1990 \begin_layout Subsection*
1991 LFUN_ESCAPE
1992 \end_layout
1993 \begin_layout Description
1994 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD. Inside math mode jumps out of the math inset.
1995 \end_layout
1996 \begin_layout Description
1997 Syntax escape
1998 \end_layout
1999 \begin_layout Description
2000 Origin Lgb, 17 May 2001
2001 \end_layout
2002
2003 \begin_layout Subsection*
2004 LFUN_FILE_INSERT
2005 \end_layout
2006 \begin_layout Description
2007 Action Inserts another LyX file.
2008 \end_layout
2009 \begin_layout Description
2010 Syntax file-insert [<FILE>]
2011 \end_layout
2012 \begin_layout Description
2013 Params <FILE>: Filename to be inserted.
2014 \end_layout
2015
2016 \begin_layout Subsection*
2017 LFUN_FILE_INSERT_PLAINTEXT
2018 \end_layout
2019 \begin_layout Description
2020 Action Inserts plain text file.
2021 \end_layout
2022 \begin_layout Description
2023 Syntax file-insert-plaintext [<FILE>]
2024 \end_layout
2025 \begin_layout Description
2026 Params <FILE>: Filename to be inserted.
2027 \end_layout
2028 \begin_layout Description
2029 Origin CFO-G, 19 Nov 1997
2030 \end_layout
2031
2032 \begin_layout Subsection*
2033 LFUN_FILE_INSERT_PLAINTEXT_PARA
2034 \end_layout
2035 \begin_layout Description
2036 Action Inserts plain text file as paragraph (i.e. join lines).
2037 \end_layout
2038 \begin_layout Description
2039 Syntax file-insert-plaintext-para [<FILE>]
2040 \end_layout
2041 \begin_layout Description
2042 Params <FILE>: Filename to be inserted.
2043 \end_layout
2044 \begin_layout Description
2045 Origin Levon, 14 Feb 2001
2046 \end_layout
2047
2048 \begin_layout Subsection*
2049 LFUN_FILE_OPEN
2050 \end_layout
2051 \begin_layout Description
2052 Action Open LyX document.
2053 \end_layout
2054 \begin_layout Description
2055 Syntax file-open [<FILE>]
2056 \end_layout
2057 \begin_layout Description
2058 Params <FILE>: Filename to be opened.
2059 \end_layout
2060
2061 \begin_layout Subsection*
2062 LFUN_FINISHED_BACKWARD
2063 \end_layout
2064 \begin_layout Description
2065 Action Moves the cursor out of the current slice, going backwards.
2066 \end_layout
2067 \begin_layout Description
2068 Notion See also LFUN_FINISHED_FORWARD.
2069 \end_layout
2070
2071 \begin_layout Subsection*
2072 LFUN_FINISHED_FORWARD
2073 \end_layout
2074 \begin_layout Description
2075 Action Moves the cursor out of the current slice, going forward.
2076 \end_layout
2077 \begin_layout Description
2078 Notion Cursor movement within an inset may be different than cursor movement in the surrounding text. This action should be called automatically by the cursor movement within the inset, when movement within the inset has ceased (reached the end of the last paragraph, for example), in order to move correctly back into the surrounding text.
2079 \end_layout
2080
2081 \begin_layout Subsection*
2082 LFUN_FINISHED_LEFT
2083 \end_layout
2084 \begin_layout Description
2085 Action Moves the cursor out of the current slice, going left.
2086 \end_layout
2087 \begin_layout Description
2088 Notion See also LFUN_FINISHED_FORWARD.
2089 \end_layout
2090
2091 \begin_layout Subsection*
2092 LFUN_FINISHED_RIGHT
2093 \end_layout
2094 \begin_layout Description
2095 Action Moves the cursor out of the current slice, going right.
2096 \end_layout
2097 \begin_layout Description
2098 Notion See also LFUN_FINISHED_FORWARD
2099 \end_layout
2100
2101 \begin_layout Subsection*
2102 LFUN_FLEX_INSERT
2103 \end_layout
2104 \begin_layout Description
2105 Action Inserts CharStyle, Custom inset or XML short element.
2106 \end_layout
2107 \begin_layout Description
2108 Notion Look into the Customization manual for more information about these elements.
2109 \begin_inset Newline newline
2110 \end_inset
2111
2112 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.
2113 \begin_inset Newline newline
2114 \end_inset
2115
2116 For dissolving the element see LFUN_INSET_DISSOLVE.
2117 \end_layout
2118 \begin_layout Description
2119 Syntax flex-insert Name
2120 \end_layout
2121 \begin_layout Description
2122 Params Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout Name or InsetLayout <Flex:Name>. The Flex: prefix is optional.
2123 \end_layout
2124 \begin_layout Description
2125 Sample flex-insert Code
2126 \end_layout
2127
2128 \begin_layout Subsection*
2129 LFUN_FLOAT_INSERT
2130 \end_layout
2131 \begin_layout Description
2132 Action Inserts a float inset.
2133 \end_layout
2134 \begin_layout Description
2135 Syntax float-insert <TYPE>
2136 \end_layout
2137 \begin_layout Description
2138 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2139 \end_layout
2140 \begin_layout Description
2141 Origin Lgb, 27 Jun 2000
2142 \end_layout
2143
2144 \begin_layout Subsection*
2145 LFUN_FLOAT_LIST_INSERT
2146 \end_layout
2147 \begin_layout Description
2148 Action Inserts the list of floats in the document.
2149 \end_layout
2150 \begin_layout Description
2151 Syntax float-list-insert <TYPE>
2152 \end_layout
2153 \begin_layout Description
2154 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2155 \end_layout
2156 \begin_layout Description
2157 Origin Lgb, 3 May 2001
2158 \end_layout
2159
2160 \begin_layout Subsection*
2161 LFUN_FLOAT_WIDE_INSERT
2162 \end_layout
2163 \begin_layout Description
2164 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
2165 \end_layout
2166 \begin_layout Description
2167 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
2168 \end_layout
2169 \begin_layout Description
2170 Syntax float-wide-insert <TYPE>
2171 \end_layout
2172 \begin_layout Description
2173 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
2174 \end_layout
2175 \begin_layout Description
2176 Origin Lgb, 31 Oct 2001
2177 \end_layout
2178
2179 \begin_layout Subsection*
2180 LFUN_FONT_BOLD
2181 \end_layout
2182 \begin_layout Description
2183 Action Toggles the bold font (selection-wise) using mathbf in math.
2184 \end_layout
2185 \begin_layout Description
2186 Syntax font-bold
2187 \end_layout
2188
2189 \begin_layout Subsection*
2190 LFUN_FONT_BOLDSYMBOL
2191 \end_layout
2192 \begin_layout Description
2193 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2194 \end_layout
2195 \begin_layout Description
2196 Syntax font-boldsymbol
2197 \end_layout
2198
2199 \begin_layout Subsection*
2200 LFUN_FONT_DEFAULT
2201 \end_layout
2202 \begin_layout Description
2203 Action Reverts the settings of the font to the default values (selection-wise).
2204 \end_layout
2205 \begin_layout Description
2206 Syntax font-default
2207 \end_layout
2208
2209 \begin_layout Subsection*
2210 LFUN_FONT_EMPH
2211 \end_layout
2212 \begin_layout Description
2213 Action Toggles the emphasis font style (selection-wise).
2214 \end_layout
2215 \begin_layout Description
2216 Syntax font-emph
2217 \end_layout
2218
2219 \begin_layout Subsection*
2220 LFUN_FONT_FRAK
2221 \end_layout
2222 \begin_layout Description
2223 Action Toggles Fraktur family font (math-mode, selection-wise).
2224 \end_layout
2225 \begin_layout Description
2226 Syntax font-frak
2227 \end_layout
2228 \begin_layout Description
2229 Origin vermeer, 10 Jan 2002
2230 \end_layout
2231
2232 \begin_layout Subsection*
2233 LFUN_FONT_ITAL
2234 \end_layout
2235 \begin_layout Description
2236 Action Toggles Italics font shape (math-mode, selection-wise).
2237 \end_layout
2238 \begin_layout Description
2239 Syntax font-ital
2240 \end_layout
2241 \begin_layout Description
2242 Origin vermeer, 10 Jan 2002
2243 \end_layout
2244
2245 \begin_layout Subsection*
2246 LFUN_FONT_NOUN
2247 \end_layout
2248 \begin_layout Description
2249 Action Toggles Noun text style font (selection-wise).
2250 \end_layout
2251 \begin_layout Description
2252 Syntax font-noun
2253 \end_layout
2254
2255 \begin_layout Subsection*
2256 LFUN_FONT_ROMAN
2257 \end_layout
2258 \begin_layout Description
2259 Action Toggles Roman family font (selection-wise).
2260 \end_layout
2261 \begin_layout Description
2262 Syntax font-roman
2263 \end_layout
2264
2265 \begin_layout Subsection*
2266 LFUN_FONT_SANS
2267 \end_layout
2268 \begin_layout Description
2269 Action Toggles Sans Serif family font (selection-wise).
2270 \end_layout
2271 \begin_layout Description
2272 Syntax font-sans
2273 \end_layout
2274
2275 \begin_layout Subsection*
2276 LFUN_FONT_SIZE
2277 \end_layout
2278 \begin_layout Description
2279 Action Sets font size according to lyx format string.
2280 \end_layout
2281 \begin_layout Description
2282 Syntax font-size <SIZE>
2283 \end_layout
2284 \begin_layout Description
2285 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2286 \begin_inset Newline newline
2287 \end_inset
2288
2289 largest|huge|giant|increase|decrease|default
2290 \end_layout
2291
2292 \begin_layout Subsection*
2293 LFUN_FONT_STATE
2294 \end_layout
2295 \begin_layout Description
2296 Action Returns the info about the current font.
2297 \end_layout
2298 \begin_layout Description
2299 Syntax font-state
2300 \end_layout
2301
2302 \begin_layout Subsection*
2303 LFUN_FONT_STRIKEOUT
2304 \end_layout
2305 \begin_layout Description
2306 Action Toggles strikeout (strike-through) in the font (selection-wise).
2307 \end_layout
2308 \begin_layout Description
2309 Syntax font-strikeout
2310 \end_layout
2311 \begin_layout Description
2312 Origin sanda, 3 May 2009
2313 \end_layout
2314
2315 \begin_layout Subsection*
2316 LFUN_FONT_TYPEWRITER
2317 \end_layout
2318 \begin_layout Description
2319 Action Toggles the typewriter family font (selection-wise).
2320 \end_layout
2321 \begin_layout Description
2322 Syntax font-typewriter
2323 \end_layout
2324
2325 \begin_layout Subsection*
2326 LFUN_FONT_UNDERLINE
2327 \end_layout
2328 \begin_layout Description
2329 Action Toggles underline in the font (selection-wise).
2330 \end_layout
2331 \begin_layout Description
2332 Syntax font-underline
2333 \end_layout
2334
2335 \begin_layout Subsection*
2336 LFUN_FONT_UULINE
2337 \end_layout
2338 \begin_layout Description
2339 Action Toggles double underline in the font (selection-wise).
2340 \end_layout
2341 \begin_layout Description
2342 Syntax font-underunderline
2343 \end_layout
2344 \begin_layout Description
2345 Origin sanda, 5 May 2009
2346 \end_layout
2347
2348 \begin_layout Subsection*
2349 LFUN_FONT_UWAVE
2350 \end_layout
2351 \begin_layout Description
2352 Action Toggles wavy underline in the font (selection-wise).
2353 \end_layout
2354 \begin_layout Description
2355 Syntax font-underwave
2356 \end_layout
2357 \begin_layout Description
2358 Origin sanda, 5 May 2009
2359 \end_layout
2360
2361 \begin_layout Subsection*
2362 LFUN_FOOTNOTE_INSERT
2363 \end_layout
2364 \begin_layout Description
2365 Action Inserts a footnote inset.
2366 \end_layout
2367 \begin_layout Description
2368 Syntax footnote-insert
2369 \end_layout
2370 \begin_layout Description
2371 Origin Jug, 7 Mar 2000
2372 \end_layout
2373
2374 \begin_layout Subsection*
2375 LFUN_FORWARD_SEARCH
2376 \end_layout
2377 \begin_layout Description
2378 Action Sets the cursor position in the previewed (dvi/pdf) file based on the row number in LyX window.
2379 \end_layout
2380 \begin_layout Description
2381 Notion The external program used for forward search call can be specified in LyX Output preferences. See Additional manual for details of these                settings.
2382 \end_layout
2383 \begin_layout Description
2384 Syntax forward-search
2385 \end_layout
2386 \begin_layout Description
2387 Origin sanda, 14 Apr 2010
2388 \end_layout
2389
2390 \begin_layout Subsection*
2391 LFUN_GRAPHICS_RELOAD
2392 \end_layout
2393 \begin_layout Description
2394 Action Reloads the image if necessary.
2395 \end_layout
2396 \begin_layout Description
2397 Syntax graphics-reload
2398 \end_layout
2399 \begin_layout Description
2400 Origin vfr, 10 Aug 2009
2401 \end_layout
2402
2403 \begin_layout Subsection*
2404 LFUN_HELP_OPEN
2405 \end_layout
2406 \begin_layout Description
2407 Action Open the given help file according to the language setting.
2408 \end_layout
2409 \begin_layout Description
2410 Syntax help-open <FILE>[.lyx]
2411 \end_layout
2412 \begin_layout Description
2413 Params <FILE>: any document from (/usr/share/)doc directory.
2414 \end_layout
2415 \begin_layout Description
2416 Origin Jug, 27 Jun 1999
2417 \end_layout
2418
2419 \begin_layout Subsection*
2420 LFUN_HYPERLINK_INSERT
2421 \end_layout
2422 \begin_layout Description
2423 Action Inserts hyperlinks into the document (clickable in pdf output).
2424 \end_layout
2425 \begin_layout Description
2426 Notion Hyperlink target can be set via selection + hyperlink-insert function.
2427 \end_layout
2428 \begin_layout Description
2429 Syntax href-insert [<TARGET>]
2430 \end_layout
2431 \begin_layout Description
2432 Origin CFO-G, 21 Nov 1997
2433 \end_layout
2434
2435 \begin_layout Subsection*
2436 LFUN_INDEX_INSERT
2437 \end_layout
2438 \begin_layout Description
2439 Action Inserts Index entry.
2440 \end_layout
2441 \begin_layout Description
2442 Notion It automatically takes the word on the cursor position.
2443 \end_layout
2444 \begin_layout Description
2445 Syntax index-insert [<TYPE:Name>]
2446 \end_layout
2447 \begin_layout Description
2448 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2449 \end_layout
2450 \begin_layout Description
2451 Origin leeming, 3 Aug 2000
2452 \end_layout
2453
2454 \begin_layout Subsection*
2455 LFUN_INDEX_PRINT
2456 \end_layout
2457 \begin_layout Description
2458 Action Inserts list of Index entries on a new page.
2459 \end_layout
2460 \begin_layout Description
2461 Syntax index-print [<TYPE:Name>]
2462 \end_layout
2463 \begin_layout Description
2464 Params <TYPE:Name>: name of the index, if multiple indices are defined. With an empty argument, the default index is selected.
2465 \end_layout
2466 \begin_layout Description
2467 Origin Lgb, 27 Feb 1997
2468 \end_layout
2469
2470 \begin_layout Subsection*
2471 LFUN_INFO_INSERT
2472 \end_layout
2473 \begin_layout Description
2474 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
2475 \end_layout
2476 \begin_layout Description
2477 Notion Apart from lfun arguments you can use the following method:
2478 \begin_inset Newline newline
2479 \end_inset
2480
2481 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
2482 \begin_inset Newline newline
2483 \end_inset
2484
2485 2. select the text and run info-insert lfun.
2486 \end_layout
2487 \begin_layout Description
2488 Syntax info-insert <TYPE> <ARG>
2489 \end_layout
2490 \begin_layout Description
2491 Params <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer
2492 \begin_inset Newline newline
2493 \end_inset
2494
2495 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
2496 \begin_inset Newline newline
2497 \end_inset
2498
2499                       shortcut[s]: name of lfun (e.g math-insert
2500 \backslash
2501 alpha)
2502 \begin_inset Newline newline
2503 \end_inset
2504
2505                       lyxrc: name of rc_entry (e.g. bind_file)
2506 \begin_inset Newline newline
2507 \end_inset
2508
2509                       lyxinfo: "version" - used version of LyX
2510 \begin_inset Newline newline
2511 \end_inset
2512
2513                       package: name of latex package (e.g. listings)
2514 \begin_inset Newline newline
2515 \end_inset
2516
2517                       textclass: name of textclass (e.g. article)
2518 \begin_inset Newline newline
2519 \end_inset
2520
2521                       menu: name of lfun used in menu
2522 \begin_inset Newline newline
2523 \end_inset
2524
2525                       icon: icon of lfun used in toolbar
2526 \begin_inset Newline newline
2527 \end_inset
2528
2529                       buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
2530 \end_layout
2531 \begin_layout Description
2532 Sample command-sequence info-insert buffer path; info-insert buffer name
2533 \end_layout
2534 \begin_layout Description
2535 Origin bpeng, 7 Oct 2007
2536 \end_layout
2537
2538 \begin_layout Subsection*
2539 LFUN_INSET_APPLY
2540 \end_layout
2541 \begin_layout Description
2542 Action Apply data for an inset.
2543 \end_layout
2544 \begin_layout Description
2545 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.
2546 \end_layout
2547 \begin_layout Description
2548 Syntax inset-apply <ARGS>
2549 \end_layout
2550 \begin_layout Description
2551 Params See LFUN_INSET_INSERT .
2552 \end_layout
2553
2554 \begin_layout Subsection*
2555 LFUN_INSET_BEGIN
2556 \end_layout
2557 \begin_layout Description
2558 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
2559 \end_layout
2560 \begin_layout Description
2561 Syntax inset-begin
2562 \end_layout
2563 \begin_layout Description
2564 Origin lasgouttes, 16 Mar 2009
2565 \end_layout
2566
2567 \begin_layout Subsection*
2568 LFUN_INSET_BEGIN_SELECT
2569 \end_layout
2570 \begin_layout Description
2571 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).
2572 \end_layout
2573 \begin_layout Description
2574 Syntax inset-begin-select
2575 \end_layout
2576 \begin_layout Description
2577 Origin lasgouttes, 16 Mar 2009
2578 \end_layout
2579
2580 \begin_layout Subsection*
2581 LFUN_INSET_COPY_AS
2582 \end_layout
2583 \begin_layout Description
2584 Action Copies the inset to the clipboard as a certain type.
2585 \end_layout
2586 \begin_layout Description
2587 Notion Currently used only for InsetInfo where its content is copied as a text.
2588 \end_layout
2589 \begin_layout Description
2590 Syntax inset-copy-as
2591 \end_layout
2592 \begin_layout Description
2593 Origin vfr, 18 Apr 2010
2594 \end_layout
2595
2596 \begin_layout Subsection*
2597 LFUN_INSET_DIALOG_UPDATE
2598 \end_layout
2599 \begin_layout Description
2600 Action Updates the values inside the dialog from the inset.
2601 \end_layout
2602 \begin_layout Description
2603 Notion This is an internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
2604 \end_layout
2605 \begin_layout Description
2606 Params <DIALOG-NAME>
2607 \end_layout
2608 \begin_layout Description
2609 Origin leeming, 25 Feb 2003
2610 \end_layout
2611
2612 \begin_layout Subsection*
2613 LFUN_INSET_DISSOLVE
2614 \end_layout
2615 \begin_layout Description
2616 Action Dissolve the current inset into text.
2617 \end_layout
2618 \begin_layout Description
2619 Syntax inset-dissolve [<INSET>]
2620 \end_layout
2621 \begin_layout Description
2622 Params <INSET>: 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.
2623 \begin_inset Newline newline
2624 \end_inset
2625
2626 For values see lyx::InsetLayout::lyxtype_ .
2627 \end_layout
2628 \begin_layout Description
2629 Origin JSpitz, 7 Aug 2006
2630 \end_layout
2631
2632 \begin_layout Subsection*
2633 LFUN_INSET_EDIT
2634 \end_layout
2635 \begin_layout Description
2636 Action Edit the inset at cursor with an external application, if one is attributed.
2637 \end_layout
2638 \begin_layout Description
2639 Syntax inset-edit [<INSET_PARAMS>]
2640 \end_layout
2641 \begin_layout Description
2642 Params <INSET_PARAMS>: Parameters for the inset.
2643 \begin_inset Newline newline
2644 \end_inset
2645
2646 Currently only the filename will be considered.
2647 \end_layout
2648 \begin_layout Description
2649 Origin JSpitzm, 27 Apr 2006
2650 \end_layout
2651
2652 \begin_layout Subsection*
2653 LFUN_INSET_END
2654 \end_layout
2655 \begin_layout Description
2656 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
2657 \end_layout
2658 \begin_layout Description
2659 Syntax inset-end
2660 \end_layout
2661 \begin_layout Description
2662 Origin lasgouttes, 16 Mar 2009
2663 \end_layout
2664
2665 \begin_layout Subsection*
2666 LFUN_INSET_END_SELECT
2667 \end_layout
2668 \begin_layout Description
2669 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).
2670 \end_layout
2671 \begin_layout Description
2672 Syntax inset-end-select
2673 \end_layout
2674 \begin_layout Description
2675 Origin lasgouttes, 16 Mar 2009
2676 \end_layout
2677
2678 \begin_layout Subsection*
2679 LFUN_INSET_FORALL
2680 \end_layout
2681 \begin_layout Description
2682 Action Apply the given commands on insets of a given name.
2683 \end_layout
2684 \begin_layout Description
2685 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.
2686 \end_layout
2687 \begin_layout Description
2688 Syntax inset-forall <NAME> <LFUN-COMMAND>
2689 \begin_inset Newline newline
2690 \end_inset
2691
2692 <NAME>: Type of Inset. If <NAME> 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.
2693 \end_layout
2694 \begin_layout Description
2695 Sample Remove all index insets:
2696 \begin_inset Newline newline
2697 \end_inset
2698
2699                    inset-forall Index char-delete-forward
2700 \begin_inset Newline newline
2701 \end_inset
2702
2703 Close all Notes (also works for a particular branch, for example):
2704 \begin_inset Newline newline
2705 \end_inset
2706
2707                    inset-forall Note inset-toggle close
2708 \begin_inset Newline newline
2709 \end_inset
2710
2711 Transform all yellow notes to comments
2712 \begin_inset Newline newline
2713 \end_inset
2714
2715                    inset-forall Note:Note inset-modify note Note Comment
2716 \begin_inset Newline newline
2717 \end_inset
2718
2719 Try to put LyX in an infinite loop if there is at least a Note:
2720 \begin_inset Newline newline
2721 \end_inset
2722
2723                    inset-forall Note char-backward
2724 \end_layout
2725 \begin_layout Description
2726 Origin lasgouttes, 27 Nov 2009
2727 \end_layout
2728
2729 \begin_layout Subsection*
2730 LFUN_INSET_INSERT
2731 \end_layout
2732 \begin_layout Description
2733 Action Insert new inset (type given by the parameters).
2734 \end_layout
2735 \begin_layout Description
2736 Syntax inset-insert <INSET> <ARGS>
2737 \end_layout
2738 \begin_layout Description
2739 Params <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|
2740 \begin_inset Newline newline
2741 \end_inset
2742
2743                          hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>
2744 \begin_inset Newline newline
2745 \end_inset
2746
2747 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2748 \end_layout
2749 \begin_layout Description
2750 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
2751 \backslash
2752 end_inset
2753 \begin_inset Newline newline
2754 \end_inset
2755
2756 where <label name> is the name of the referenced label and <Format> is one of the following:
2757 \begin_inset Newline newline
2758 \end_inset
2759
2760 ref -- <reference>
2761 \begin_inset Newline newline
2762 \end_inset
2763
2764 eqref -- (<reference>)
2765 \begin_inset Newline newline
2766 \end_inset
2767
2768 pageref -- <page>
2769 \begin_inset Newline newline
2770 \end_inset
2771
2772 vpageref -- on <page>
2773 \begin_inset Newline newline
2774 \end_inset
2775
2776 vref -- <reference> on <page>
2777 \begin_inset Newline newline
2778 \end_inset
2779
2780 formatted -- Formatted reference
2781 \end_layout
2782
2783 \begin_layout Subsection*
2784 LFUN_INSET_MODIFY
2785 \end_layout
2786 \begin_layout Description
2787 Action Modify some properties of an inset.
2788 \end_layout
2789 \begin_layout Description
2790 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
2791 \end_layout
2792 \begin_layout Description
2793 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>inset-modify tabular <FEATURE> [<ARG>]
2794 \end_layout
2795 \begin_layout Description
2796 Params Generally see LFUN_INSET_INSERT for further details.
2797 \begin_inset Newline newline
2798 \end_inset
2799
2800 In case that <INSET> is "tabular" various math-environment features are handled as well, e.g. add-vline-left/right for the Grid/Array environment.
2801 \begin_inset Newline newline
2802 \end_inset
2803
2804 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|
2805 \begin_inset Newline newline
2806 \end_inset
2807
2808 copy-column|move-column-right|move-column-left|move-row-down|move-row-up|
2809 \begin_inset Newline newline
2810 \end_inset
2811
2812 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2813 \begin_inset Newline newline
2814 \end_inset
2815
2816 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2817 \begin_inset Newline newline
2818 \end_inset
2819
2820 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2821 \begin_inset Newline newline
2822 \end_inset
2823
2824 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2825 \begin_inset Newline newline
2826 \end_inset
2827
2828 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2829 \begin_inset Newline newline
2830 \end_inset
2831
2832 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2833 \begin_inset Newline newline
2834 \end_inset
2835
2836 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2837 \begin_inset Newline newline
2838 \end_inset
2839
2840 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2841 \begin_inset Newline newline
2842 \end_inset
2843
2844 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2845 \begin_inset Newline newline
2846 \end_inset
2847
2848 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2849 \begin_inset Newline newline
2850 \end_inset
2851
2852 set-special-column|set-special-multicolumn|set-special-multirow|
2853 \begin_inset Newline newline
2854 \end_inset
2855
2856 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2857 \begin_inset Newline newline
2858 \end_inset
2859
2860 set-interline-space|set-border-lines|tabular-valign-top|
2861 \begin_inset Newline newline
2862 \end_inset
2863
2864 tabular-valign-middle|tabular-valign-bottom|set-tabular-width <ARG>: additional argument for some commands, use debug mode to explore its values.
2865 \end_layout
2866 \begin_layout Description
2867 Sample inset-modify note Note Comment
2868 \begin_inset Newline newline
2869 \end_inset
2870
2871                inset-modify changetype Ovalbox
2872 \end_layout
2873
2874 \begin_layout Subsection*
2875 LFUN_INSET_SELECT_ALL
2876 \end_layout
2877 \begin_layout Description
2878 Action Selects all contents of an inset.
2879 \end_layout
2880 \begin_layout Description
2881 Syntax inset-select-all
2882 \end_layout
2883 \begin_layout Description
2884 Origin vfr, 22 Aug 2009
2885 \end_layout
2886
2887 \begin_layout Subsection*
2888 LFUN_INSET_SETTINGS
2889 \end_layout
2890 \begin_layout Description
2891 Action Open the inset's properties dialog.
2892 \end_layout
2893 \begin_layout Description
2894 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float, graphics, href, include, index, index_print, label, line, listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2895 \end_layout
2896 \begin_layout Description
2897 Syntax inset-settings <INSET>
2898 \end_layout
2899 \begin_layout Description
2900 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2901 \begin_inset Newline newline
2902 \end_inset
2903
2904 graphics|href|include|index|index_print|label|line|
2905 \begin_inset Newline newline
2906 \end_inset
2907
2908 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2909 \end_layout
2910
2911 \begin_layout Subsection*
2912 LFUN_INSET_TOGGLE
2913 \end_layout
2914 \begin_layout Description
2915 Action Toggles the collapsible inset at cursor position, or the inset we are currently in.
2916 \end_layout
2917 \begin_layout Description
2918 Syntax inset-toggle [<ARG>]
2919 \end_layout
2920 \begin_layout Description
2921 Params <ARG>: <open|close|toggle|assign>.
2922 \begin_inset Newline newline
2923 \end_inset
2924
2925 open/close/toggle are for collapsible insets. toggle is used when no argument is given.
2926 \begin_inset Newline newline
2927 \end_inset
2928
2929 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
2930 \end_layout
2931 \begin_layout Description
2932 Origin lasgouttes, 19 Jul 2001
2933 \end_layout
2934
2935 \begin_layout Subsection*
2936 LFUN_IN_IPA
2937 \end_layout
2938 \begin_layout Description
2939 Action Only active in IPA inset.
2940 \end_layout
2941 \begin_layout Description
2942 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.
2943 \end_layout
2944 \begin_layout Description
2945 Syntax in-ipa
2946 \end_layout
2947 \begin_layout Description
2948 Origin spitz, 20 May 2012
2949 \end_layout
2950
2951 \begin_layout Subsection*
2952 LFUN_IN_MATHMACROTEMPLATE
2953 \end_layout
2954 \begin_layout Description
2955 Action Only active in Math Macro definition.
2956 \end_layout
2957 \begin_layout Description
2958 Notion Dummy function which is only active in a Math Macro definition. It's used to toggle the Math Macro toolbar if the cursor moves into a Math Macro definition.
2959 \end_layout
2960 \begin_layout Description
2961 Syntax in-mathmacrotemplate
2962 \end_layout
2963 \begin_layout Description
2964 Origin sts, 06 January 2008
2965 \end_layout
2966
2967 \begin_layout Subsection*
2968 LFUN_IPAMACRO_INSERT
2969 \end_layout
2970 \begin_layout Description
2971 Action Inserts special IPA macros into the document.
2972 \end_layout
2973 \begin_layout Description
2974 Syntax ipamacro-insert <CHAR>
2975 \end_layout
2976 \begin_layout Description
2977 Params <CHAR>: tone-falling, tone-rising, tone-high-rising, tone-low-rising, tone-high-rising-falling, deco bottomtiebar, deco toptiebar.
2978 \end_layout
2979 \begin_layout Description
2980 Origin JSpitzm, 22 Aug 2012
2981 \end_layout
2982
2983 \begin_layout Subsection*
2984 LFUN_IPA_INSERT
2985 \end_layout
2986 \begin_layout Description
2987 Action Inserts an IPA inset.
2988 \end_layout
2989 \begin_layout Description
2990 Syntax ipa-insert
2991 \end_layout
2992 \begin_layout Description
2993 Origin spitz, 05 Mar 2012
2994 \end_layout
2995
2996 \begin_layout Subsection*
2997 LFUN_KEYMAP_OFF
2998 \end_layout
2999 \begin_layout Description
3000 Action Turn off the loaded keyboard map.
3001 \end_layout
3002 \begin_layout Description
3003 Syntax keymap-off
3004 \end_layout
3005
3006 \begin_layout Subsection*
3007 LFUN_KEYMAP_PRIMARY
3008 \end_layout
3009 \begin_layout Description
3010 Action Turn on the primary keyboard map.
3011 \end_layout
3012 \begin_layout Description
3013 Notion Maps were widely used in past, when X-windows didn't have nowadays keyboard support. They can be still used to maintain uniform keyboard layout across the various platforms.
3014 \begin_inset Newline newline
3015 \end_inset
3016
3017 The language is to be set in the Preferences dialog.
3018 \end_layout
3019 \begin_layout Description
3020 Syntax keymap-primary
3021 \end_layout
3022
3023 \begin_layout Subsection*
3024 LFUN_KEYMAP_SECONDARY
3025 \end_layout
3026 \begin_layout Description
3027 Action Turn on the secondary keyboard map.
3028 \end_layout
3029 \begin_layout Description
3030 Syntax keymap-secondary
3031 \end_layout
3032
3033 \begin_layout Subsection*
3034 LFUN_KEYMAP_TOGGLE
3035 \end_layout
3036 \begin_layout Description
3037 Action Toggles keyboard maps (first/second/off).
3038 \end_layout
3039 \begin_layout Description
3040 Syntax keymap-toggle
3041 \end_layout
3042 \begin_layout Description
3043 Origin leeming, 30 Mar 2004
3044 \end_layout
3045
3046 \begin_layout Subsection*
3047 LFUN_LABEL_COPY_AS_REF
3048 \end_layout
3049 \begin_layout Description
3050 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3051 \end_layout
3052 \begin_layout Description
3053 Syntax copy-label-as-reference <LABEL>
3054 \end_layout
3055 \begin_layout Description
3056 Params <LABEL>: The label to copy (for multi-line math)
3057 \end_layout
3058 \begin_layout Description
3059 Origin sts, 16 Nov 2008
3060 \end_layout
3061
3062 \begin_layout Subsection*
3063 LFUN_LABEL_GOTO
3064 \end_layout
3065 \begin_layout Description
3066 Action Goto a label.
3067 \end_layout
3068 \begin_layout Description
3069 Syntax label-goto [<LABEL>]
3070 \end_layout
3071 \begin_layout Description
3072 Params <LABEL>: Requested label. If no label is given and reference is on cursor position, Bookmark 0 is saved and cursor moves to the position of referenced label.
3073 \end_layout
3074 \begin_layout Description
3075 Origin Ale, 6 Aug 1997
3076 \end_layout
3077
3078 \begin_layout Subsection*
3079 LFUN_LABEL_INSERT
3080 \end_layout
3081 \begin_layout Description
3082 Action Inserts label to text or displayed formula.
3083 \end_layout
3084 \begin_layout Description
3085 Syntax label-insert [<LABEL>]
3086 \end_layout
3087 \begin_layout Description
3088 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3089 \end_layout
3090
3091 \begin_layout Subsection*
3092 LFUN_LABEL_INSERT_AS_REF
3093 \end_layout
3094 \begin_layout Description
3095 Action Inserts the label (in ToC pane) as a cross-reference at the position of the cursor.
3096 \end_layout
3097 \begin_layout Description
3098 Syntax label-insert-as-reference
3099 \end_layout
3100 \begin_layout Description
3101 Origin vfr, 7 Apr 2009
3102 \end_layout
3103
3104 \begin_layout Subsection*
3105 LFUN_LANGUAGE
3106 \end_layout
3107 \begin_layout Description
3108 Action Set language from the current cursor position.
3109 \end_layout
3110 \begin_layout Description
3111 Syntax language <LANG> [set]
3112 \end_layout
3113 \begin_layout Description
3114 Params <LANG>: Requested language. Look in lib/languages for the list. "language reset" or "language" (without param) reset to the document language. set: If used, the language will be set to the specified language. Otherwise, the language will be toggled (i.e., if the current language is LANG, switch to the document language or the default language, if LANG is the document language).
3115 \end_layout
3116 \begin_layout Description
3117 Origin Dekel, 2 Mar 2000
3118 \end_layout
3119
3120 \begin_layout Subsection*
3121 LFUN_LAYOUT
3122 \end_layout
3123 \begin_layout Description
3124 Action Sets the layout (that is, environment) for the current paragraph.
3125 \end_layout
3126 \begin_layout Description
3127 Syntax layout <LAYOUT>
3128 \end_layout
3129 \begin_layout Description
3130 Params <LAYOUT>: the layout to use
3131 \end_layout
3132
3133 \begin_layout Subsection*
3134 LFUN_LAYOUT_MODULES_CLEAR
3135 \end_layout
3136 \begin_layout Description
3137 Action Clears the module list.
3138 \end_layout
3139 \begin_layout Description
3140 Notion Clears the list of included modules for the current buffer.
3141 \end_layout
3142 \begin_layout Description
3143 Syntax layout-modules-clear
3144 \end_layout
3145 \begin_layout Description
3146 Origin rgh, 25 August 2007
3147 \end_layout
3148
3149 \begin_layout Subsection*
3150 LFUN_LAYOUT_MODULE_ADD
3151 \end_layout
3152 \begin_layout Description
3153 Action Adds a module.
3154 \end_layout
3155 \begin_layout Description
3156 Notion Adds a module to the list of included modules for the current buffer.
3157 \end_layout
3158 \begin_layout Description
3159 Syntax layout-module-add <MODULE>
3160 \end_layout
3161 \begin_layout Description
3162 Params <MODULE>: the module to be added
3163 \end_layout
3164 \begin_layout Description
3165 Origin rgh, 25 August 2007
3166 \end_layout
3167
3168 \begin_layout Subsection*
3169 LFUN_LAYOUT_PARAGRAPH
3170 \end_layout
3171 \begin_layout Description
3172 Action Launches the paragraph settings dialog.
3173 \end_layout
3174 \begin_layout Description
3175 Syntax layout-paragraph
3176 \end_layout
3177
3178 \begin_layout Subsection*
3179 LFUN_LAYOUT_RELOAD
3180 \end_layout
3181 \begin_layout Description
3182 Action Reloads layout information.
3183 \end_layout
3184 \begin_layout Description
3185 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.
3186 \end_layout
3187 \begin_layout Description
3188 Syntax layout-reload
3189 \end_layout
3190 \begin_layout Description
3191 Origin rgh, 3 September 2007
3192 \end_layout
3193
3194 \begin_layout Subsection*
3195 LFUN_LAYOUT_TABULAR
3196 \end_layout
3197 \begin_layout Description
3198 Action Launches the tabular settings dialog.
3199 \end_layout
3200 \begin_layout Description
3201 Syntax layout-tabular
3202 \end_layout
3203 \begin_layout Description
3204 Origin Jug, 31 Jul 2000
3205 \end_layout
3206
3207 \begin_layout Subsection*
3208 LFUN_LINE_BEGIN
3209 \end_layout
3210 \begin_layout Description
3211 Action Move the cursor to the beginning of the (screen) line.
3212 \end_layout
3213 \begin_layout Description
3214 Syntax line-begin
3215 \end_layout
3216
3217 \begin_layout Subsection*
3218 LFUN_LINE_BEGIN_SELECT
3219 \end_layout
3220 \begin_layout Description
3221 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
3222 \end_layout
3223 \begin_layout Description
3224 Syntax line-begin-select
3225 \end_layout
3226
3227 \begin_layout Subsection*
3228 LFUN_LINE_DELETE
3229 \end_layout
3230 \begin_layout Description
3231 Action Deletes the letters to the end of the (screen) line or deletes the selection.
3232 \end_layout
3233 \begin_layout Description
3234 Syntax line-delete-forward
3235 \end_layout
3236
3237 \begin_layout Subsection*
3238 LFUN_LINE_END
3239 \end_layout
3240 \begin_layout Description
3241 Action Move the cursor to the end of the (screen) line.
3242 \end_layout
3243 \begin_layout Description
3244 Syntax line-end
3245 \end_layout
3246
3247 \begin_layout Subsection*
3248 LFUN_LINE_END_SELECT
3249 \end_layout
3250 \begin_layout Description
3251 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
3252 \end_layout
3253 \begin_layout Description
3254 Syntax line-end-select
3255 \end_layout
3256
3257 \begin_layout Subsection*
3258 LFUN_LISTING_INSERT
3259 \end_layout
3260 \begin_layout Description
3261 Action Inserts a new listings inset.
3262 \end_layout
3263 \begin_layout Description
3264 Syntax listing-insert
3265 \end_layout
3266 \begin_layout Description
3267 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
3268 \end_layout
3269
3270 \begin_layout Subsection*
3271 LFUN_LYXRC_APPLY
3272 \end_layout
3273 \begin_layout Description
3274 Action Apply the given settings to user preferences.
3275 \end_layout
3276 \begin_layout Description
3277 Syntax lyxrc-apply <SETTINGS>
3278 \end_layout
3279 \begin_layout Description
3280 Params <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences to get an idea which commands to use and their syntax. lyx::LyXRC::LyXRCTags has the list of possible commands.
3281 \end_layout
3282
3283 \begin_layout Subsection*
3284 LFUN_LYX_QUIT
3285 \end_layout
3286 \begin_layout Description
3287 Action Terminates the current LyX instance.
3288 \end_layout
3289 \begin_layout Description
3290 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3291 \end_layout
3292 \begin_layout Description
3293 Syntax lyx-quit
3294 \end_layout
3295
3296 \begin_layout Subsection*
3297 LFUN_MARGINALNOTE_INSERT
3298 \end_layout
3299 \begin_layout Description
3300 Action Inserts a marginal note.
3301 \end_layout
3302 \begin_layout Description
3303 Syntax marginalnote-insert
3304 \end_layout
3305 \begin_layout Description
3306 Origin Lgb, 26 Jun 2000
3307 \end_layout
3308
3309 \begin_layout Subsection*
3310 LFUN_MARK_OFF
3311 \end_layout
3312 \begin_layout Description
3313 Action Disable selecting of text-region.
3314 \end_layout
3315 \begin_layout Description
3316 Syntax mark-off
3317 \end_layout
3318
3319 \begin_layout Subsection*
3320 LFUN_MARK_ON
3321 \end_layout
3322 \begin_layout Description
3323 Action Enable selecting of text-region.
3324 \end_layout
3325 \begin_layout Description
3326 Notion After enabling you can simply move arrow keys to get selected region.
3327 \end_layout
3328 \begin_layout Description
3329 Syntax mark-on
3330 \end_layout
3331
3332 \begin_layout Subsection*
3333 LFUN_MARK_TOGGLE
3334 \end_layout
3335 \begin_layout Description
3336 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
3337 \end_layout
3338 \begin_layout Description
3339 Syntax mark-toggle
3340 \end_layout
3341 \begin_layout Description
3342 Origin Andre, May 5 2006
3343 \end_layout
3344
3345 \begin_layout Subsection*
3346 LFUN_MASTER_BUFFER_UPDATE
3347 \end_layout
3348 \begin_layout Description
3349 Action Update (export) the document built from the master buffer, if the current buffer is part of a master/child document.
3350 \end_layout
3351 \begin_layout Description
3352 Syntax master-buffer-update [<FORMAT>]
3353 \end_layout
3354 \begin_layout Description
3355 Params <FORMAT>: 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.
3356 \end_layout
3357 \begin_layout Description
3358 Origin Tommaso, 20 Sep 2007
3359 \end_layout
3360
3361 \begin_layout Subsection*
3362 LFUN_MASTER_BUFFER_VIEW
3363 \end_layout
3364 \begin_layout Description
3365 Action Show a preview built from the master buffer, if available. if the current buffer is part of a master/child document.
3366 \end_layout
3367 \begin_layout Description
3368 Syntax master-buffer-view [<FORMAT>]
3369 \end_layout
3370 \begin_layout Description
3371 Params <FORMAT>: 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.
3372 \end_layout
3373 \begin_layout Description
3374 Origin Tommaso, 20 Sep 2007
3375 \end_layout
3376
3377 \begin_layout Subsection*
3378 LFUN_MATH_AMS_MATRIX
3379 \end_layout
3380 \begin_layout Description
3381 Action Inserts an extended matrix as provided by the amsmath package.
3382 \end_layout
3383 \begin_layout Description
3384 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3385 \end_layout
3386 \begin_layout Description
3387 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created. Possible values include pmatrix, bmatrix, Bmatrix, vmatrix, Vmatrix and matrix. The default is 'matrix'.
3388 \end_layout
3389 \begin_layout Description
3390 Sample math-ams-matrix 3 3 bmatrix
3391 \end_layout
3392
3393 \begin_layout Subsection*
3394 LFUN_MATH_BIGDELIM
3395 \end_layout
3396 \begin_layout Description
3397 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
3398 \end_layout
3399 \begin_layout Description
3400 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
3401 \end_layout
3402 \begin_layout Description
3403 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
3404 \begin_inset Newline newline
3405 \end_inset
3406
3407 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
3408 \end_layout
3409 \begin_layout Description
3410 Sample math-bigdelim "Bigl" "
3411 \backslash
3412 Downarrow" "Bigr" "
3413 \backslash
3414 }"
3415 \end_layout
3416 \begin_layout Description
3417 Origin Enrico & Georg, 7 May 2006
3418 \end_layout
3419
3420 \begin_layout Subsection*
3421 LFUN_MATH_DELIM
3422 \end_layout
3423 \begin_layout Description
3424 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
3425 \end_layout
3426 \begin_layout Description
3427 Syntax math-delim [<LEFT>] [<RIGHT>]
3428 \end_layout
3429 \begin_layout Description
3430 Params <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by either a LaTeX name or a valid character. ( is the default letter.
3431 \end_layout
3432 \begin_layout Description
3433 Sample math-delim { rangle
3434 \end_layout
3435 \begin_layout Description
3436 Origin Alejandro, 18 Jun 1996
3437 \end_layout
3438
3439 \begin_layout Subsection*
3440 LFUN_MATH_DISPLAY
3441 \end_layout
3442 \begin_layout Description
3443 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
3444 \end_layout
3445 \begin_layout Description
3446 Syntax math-display [<ARG>]
3447 \end_layout
3448 \begin_layout Description
3449 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
3450 \end_layout
3451 \begin_layout Description
3452 Origin Alejandro, 18 Jun 1996
3453 \end_layout
3454
3455 \begin_layout Subsection*
3456 LFUN_MATH_EXTERN
3457 \end_layout
3458 \begin_layout Description
3459 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
3460 \end_layout
3461 \begin_layout Description
3462 Notion Selection can be used to determine the input for the external program.
3463 \end_layout
3464 \begin_layout Description
3465 Syntax math-extern <LANG> [<COMMAND>]
3466 \end_layout
3467 \begin_layout Description
3468 Params <LANG>: octave|maxima|maple|mathematica|script
3469 \begin_inset Newline newline
3470 \end_inset
3471
3472 where "script" stands for the external script (normalized expression will be passed)
3473 \end_layout
3474 \begin_layout Description
3475 Sample math-extern maple simplify
3476 \end_layout
3477 \begin_layout Description
3478 Origin Andre, 24 Apr 2001
3479 \end_layout
3480
3481 \begin_layout Subsection*
3482 LFUN_MATH_FONT_STYLE
3483 \end_layout
3484 \begin_layout Description
3485 Action Changes the text style used in math.
3486 \end_layout
3487 \begin_layout Description
3488 Syntax math-font-style <STYLE>
3489 \end_layout
3490 \begin_layout Description
3491 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal
3492 \begin_inset Newline newline
3493 \end_inset
3494
3495 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
3496 \end_layout
3497 \begin_layout Description
3498 Origin vfr, 9 jan 2009
3499 \end_layout
3500
3501 \begin_layout Subsection*
3502 LFUN_MATH_INSERT
3503 \end_layout
3504 \begin_layout Description
3505 Action Inserts math objects and symbols.
3506 \end_layout
3507 \begin_layout Description
3508 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
3509 \backslash
3510 frac{x}{y}"), the content of cell(0) is replaced by the current selection (only works if the selection is in mathed). As an example, if "abc" is selected in mathed, "math-insert
3511 \backslash
3512 frac{x}{y}" replaces "abc" with "
3513 \backslash
3514 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z". If nothing is selected (or the selection is not in mathed), math-insert works as expected.
3515 \end_layout
3516 \begin_layout Description
3517 Syntax math-insert <ARG>
3518 \end_layout
3519 \begin_layout Description
3520 Params <ARG>: Symbol or LaTeX code to be inserted.
3521 \end_layout
3522
3523 \begin_layout Subsection*
3524 LFUN_MATH_LIMITS
3525 \end_layout
3526 \begin_layout Description
3527 Action Toggles the position of the limits from above/below to the right side an vice versa in integral symbol, a limit, a summation, etc.
3528 \end_layout
3529 \begin_layout Description
3530 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
3531 \end_layout
3532 \begin_layout Description
3533 Syntax math-limits [<STATE>]
3534 \end_layout
3535 \begin_layout Description
3536 Params <STATE>: limits|nolimits
3537 \end_layout
3538
3539 \begin_layout Subsection*
3540 LFUN_MATH_MACRO
3541 \end_layout
3542 \begin_layout Description
3543 Action Inserts a math macro definition at the cursor position in the text.
3544 \end_layout
3545 \begin_layout Description
3546 Syntax math-macro <NAME> [<NARGS>] [def]
3547 \end_layout
3548 \begin_layout Description
3549 Params <NAME>: The name of the macro, e.g. "mymacro".
3550 \begin_inset Newline newline
3551 \end_inset
3552
3553 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
3554 \end_layout
3555 \begin_layout Description
3556 Origin ale, 10 May 1997;  sts, 21 Dec 2007
3557 \end_layout
3558
3559 \begin_layout Subsection*
3560 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3561 \end_layout
3562 \begin_layout Description
3563 Action Add a greedy optional parameter.
3564 \end_layout
3565 \begin_layout Description
3566 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
3567 \end_layout
3568 \begin_layout Description
3569 Syntax math-macro-add-greedy-optional-param
3570 \end_layout
3571 \begin_layout Description
3572 Origin sts, 06 January 2008
3573 \end_layout
3574
3575 \begin_layout Subsection*
3576 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3577 \end_layout
3578 \begin_layout Description
3579 Action Add an optional parameter.
3580 \end_layout
3581 \begin_layout Description
3582 Notion Insert an optional parameter just behind the already existing optional parameters.
3583 \end_layout
3584 \begin_layout Description
3585 Syntax math-macro-add-optional-param
3586 \end_layout
3587 \begin_layout Description
3588 Origin sts, 06 January 2008
3589 \end_layout
3590
3591 \begin_layout Subsection*
3592 LFUN_MATH_MACRO_ADD_PARAM
3593 \end_layout
3594 \begin_layout Description
3595 Action Add a parameter.
3596 \end_layout
3597 \begin_layout Description
3598 Notion Add a parameter to a Math Macro.
3599 \end_layout
3600 \begin_layout Description
3601 Syntax math-macro-add-param <NUM>
3602 \end_layout
3603 \begin_layout Description
3604 Params <NUM>: The number of the parameter behind which the new one will be added (1 for the first, i.e. use 0 for add a parameter at the left), defaults to the last one.
3605 \end_layout
3606 \begin_layout Description
3607 Origin sts, 06 January 2008
3608 \end_layout
3609
3610 \begin_layout Subsection*
3611 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3612 \end_layout
3613 \begin_layout Description
3614 Action Append a greedy parameter.
3615 \end_layout
3616 \begin_layout Description
3617 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
3618 \end_layout
3619 \begin_layout Description
3620 Syntax math-macro-append-greedy-param
3621 \end_layout
3622 \begin_layout Description
3623 Origin sts, 06 January 2008
3624 \end_layout
3625
3626 \begin_layout Subsection*
3627 LFUN_MATH_MACRO_FOLD
3628 \end_layout
3629 \begin_layout Description
3630 Action Fold a Math Macro.
3631 \end_layout
3632 \begin_layout Description
3633 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
3634 \backslash
3635 foo before.
3636 \end_layout
3637 \begin_layout Description
3638 Syntax math-macro-fold
3639 \end_layout
3640 \begin_layout Description
3641 Origin sts, 06 January 2008
3642 \end_layout
3643
3644 \begin_layout Subsection*
3645 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3646 \end_layout
3647 \begin_layout Description
3648 Action Make a parameter non-optional.
3649 \end_layout
3650 \begin_layout Description
3651 Notion Turn the last optional parameter of a Math Macro into a non-optional parameter. The default value is remembered to be reused later if the user changes his mind.
3652 \end_layout
3653 \begin_layout Description
3654 Syntax math-macro-make-nonoptional
3655 \end_layout
3656 \begin_layout Description
3657 Origin sts, 06 January 2008
3658 \end_layout
3659
3660 \begin_layout Subsection*
3661 LFUN_MATH_MACRO_MAKE_OPTIONAL
3662 \end_layout
3663 \begin_layout Description
3664 Action Make a parameter optional.
3665 \end_layout
3666 \begin_layout Description
3667 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
3668 \end_layout
3669 \begin_layout Description
3670 Syntax math-macro-make-optional
3671 \end_layout
3672 \begin_layout Description
3673 Origin sts, 06 January 2008
3674 \end_layout
3675
3676 \begin_layout Subsection*
3677 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3678 \end_layout
3679 \begin_layout Description
3680 Action Remove a greedy parameter.
3681 \end_layout
3682 \begin_layout Description
3683 Notion Remove a greedy parameter of a Math Macro and spit out the values of it in every instance of the macro in the buffer. If it is an optional parameter the [valud] format is used.
3684 \end_layout
3685 \begin_layout Description
3686 Syntax math-macro-remove-greedy-param
3687 \end_layout
3688 \begin_layout Description
3689 Origin sts, 06 January 2008
3690 \end_layout
3691
3692 \begin_layout Subsection*
3693 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3694 \end_layout
3695 \begin_layout Description
3696 Action Remove the last optional parameter.
3697 \end_layout
3698 \begin_layout Description
3699 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
3700 \end_layout
3701 \begin_layout Description
3702 Syntax math-macro-remove-optional-param
3703 \end_layout
3704 \begin_layout Description
3705 Origin sts, 06 January 2008
3706 \end_layout
3707
3708 \begin_layout Subsection*
3709 LFUN_MATH_MACRO_REMOVE_PARAM
3710 \end_layout
3711 \begin_layout Description
3712 Action Remove the last parameter.
3713 \end_layout
3714 \begin_layout Description
3715 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
3716 \end_layout
3717 \begin_layout Description
3718 Syntax math-macro-remove-param <NUM>
3719 \end_layout
3720 \begin_layout Description
3721 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
3722 \end_layout
3723 \begin_layout Description
3724 Origin sts, 06 January 2008
3725 \end_layout
3726
3727 \begin_layout Subsection*
3728 LFUN_MATH_MACRO_UNFOLD
3729 \end_layout
3730 \begin_layout Description
3731 Action Unfold a Math Macro.
3732 \end_layout
3733 \begin_layout Description
3734 Notion Unfold the Math Macro the cursor is in, i.e. display it as
3735 \backslash
3736 foo.
3737 \end_layout
3738 \begin_layout Description
3739 Syntax math-macro-unfold
3740 \end_layout
3741 \begin_layout Description
3742 Origin sts, 06 January 2008
3743 \end_layout
3744
3745 \begin_layout Subsection*
3746 LFUN_MATH_MATRIX
3747 \end_layout
3748 \begin_layout Description
3749 Action Inserts a matrix.
3750 \end_layout
3751 \begin_layout Description
3752 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3753 \end_layout
3754 \begin_layout Description
3755 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b, c or t) (i.e. 1 char) and the horizontal alignments (l, c or r) (i.e. <COL> chars).
3756 \end_layout
3757 \begin_layout Description
3758 Sample math-matrix 3 3 bccc
3759 \end_layout
3760
3761 \begin_layout Subsection*
3762 LFUN_MATH_MODE
3763 \end_layout
3764 \begin_layout Description
3765 Action In text mode enters math mode (i.e. puts math insets on the current cursor position), in math mode enters text mode inside math expression.
3766 \end_layout
3767 \begin_layout Description
3768 Notion If there is some selected text, it puts the text inside created math box.
3769 \end_layout
3770 \begin_layout Description
3771 Syntax math-mode [on|<ARG>]
3772 \end_layout
3773 \begin_layout Description
3774 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
3775 \begin_inset Newline newline
3776 \end_inset
3777
3778 "on": allow only entering of math mode from text mode.
3779 \end_layout
3780 \begin_layout Description
3781 Origin Alejandro, 4 Jun 1996
3782 \end_layout
3783
3784 \begin_layout Subsection*
3785 LFUN_MATH_MUTATE
3786 \end_layout
3787 \begin_layout Description
3788 Action Mutates the type of math inset to the newly selected one.
3789 \end_layout
3790 \begin_layout Description
3791 Syntax math-mutate <TYPE>
3792 \end_layout
3793 \begin_layout Description
3794 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
3795 \end_layout
3796 \begin_layout Description
3797 Origin Andre, 23 May 2001
3798 \end_layout
3799
3800 \begin_layout Subsection*
3801 LFUN_MATH_NUMBER_LINE_TOGGLE
3802 \end_layout
3803 \begin_layout Description
3804 Action Toggles numbering of the current formula line.
3805 \end_layout
3806 \begin_layout Description
3807 Notion Must be in display formula mode.
3808 \end_layout
3809 \begin_layout Description
3810 Syntax math-number-line-toggle
3811 \end_layout
3812 \begin_layout Description
3813 Origin Alejandro, 18 Jun 1996
3814 \end_layout
3815
3816 \begin_layout Subsection*
3817 LFUN_MATH_NUMBER_TOGGLE
3818 \end_layout
3819 \begin_layout Description
3820 Action Toggles numbering/labeling of the current formula.
3821 \end_layout
3822 \begin_layout Description
3823 Notion Must be in display formula mode.
3824 \end_layout
3825 \begin_layout Description
3826 Syntax math-number-toggle
3827 \end_layout
3828 \begin_layout Description
3829 Origin Alejandro, 4 Jun 1996
3830 \end_layout
3831
3832 \begin_layout Subsection*
3833 LFUN_MATH_SIZE
3834 \end_layout
3835 \begin_layout Description
3836 Action Changes arbitrarily the size used by math fonts inside a context.
3837 \end_layout
3838 \begin_layout Description
3839 Notion Provides an interface to the LaTeX math mode font size commands.
3840 \end_layout
3841 \begin_layout Description
3842 Syntax math-size <STYLE>
3843 \end_layout
3844 \begin_layout Description
3845 Params <STYLE>:
3846 \backslash
3847 displaystyle|
3848 \backslash
3849 textstyle|
3850 \backslash
3851 scriptstyle|
3852 \backslash
3853 scriptscriptstyle
3854 \end_layout
3855 \begin_layout Description
3856 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3857 \end_layout
3858
3859 \begin_layout Subsection*
3860 LFUN_MATH_SPACE
3861 \end_layout
3862 \begin_layout Description
3863 Action Inserts space into math expression.
3864 \end_layout
3865 \begin_layout Description
3866 Notion Use spacebar after entering this space to change type of space.
3867 \end_layout
3868 \begin_layout Description
3869 Syntax math-space [<TYPE>] [<LEN>]
3870 \end_layout
3871 \begin_layout Description
3872 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
3873 \begin_inset Newline newline
3874 \end_inset
3875
3876 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
3877 \begin_inset Newline newline
3878 \end_inset
3879
3880 custom space: hspace
3881 \begin_inset Newline newline
3882 \end_inset
3883
3884 "," used by default.
3885 \begin_inset Newline newline
3886 \end_inset
3887
3888 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
3889 \begin_inset Newline newline
3890 \end_inset
3891
3892 <LEN>: length for custom spaces (hspace)
3893 \end_layout
3894 \begin_layout Description
3895 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
3896 \end_layout
3897
3898 \begin_layout Subsection*
3899 LFUN_MATH_SUBSCRIPT
3900 \end_layout
3901 \begin_layout Description
3902 Action Enters subscript expression in math expression.
3903 \end_layout
3904 \begin_layout Description
3905 Syntax math-subscript
3906 \end_layout
3907 \begin_layout Description
3908 Origin vermeer, 12 Dec 2001
3909 \end_layout
3910
3911 \begin_layout Subsection*
3912 LFUN_MATH_SUPERSCRIPT
3913 \end_layout
3914 \begin_layout Description
3915 Action Enters superscript expression in math expression.
3916 \end_layout
3917 \begin_layout Description
3918 Syntax math-superscript
3919 \end_layout
3920 \begin_layout Description
3921 Origin vermeer, 12 Dec 2001
3922 \end_layout
3923
3924 \begin_layout Subsection*
3925 LFUN_MENU_OPEN
3926 \end_layout
3927 \begin_layout Description
3928 Action Opens the menu given by its name.
3929 \end_layout
3930 \begin_layout Description
3931 Syntax menu-open <NAME>
3932 \end_layout
3933 \begin_layout Description
3934 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3935 \end_layout
3936
3937 \begin_layout Subsection*
3938 LFUN_MESSAGE
3939 \end_layout
3940 \begin_layout Description
3941 Action Shows message in statusbar (for script purposes).
3942 \end_layout
3943 \begin_layout Description
3944 Syntax message <STRING>
3945 \end_layout
3946 \begin_layout Description
3947 Origin Lgb, 8 Apr 2001
3948 \end_layout
3949
3950 \begin_layout Subsection*
3951 LFUN_META_PREFIX
3952 \end_layout
3953 \begin_layout Description
3954 Action Simulate halting Meta key (Alt key on PCs).
3955 \end_layout
3956 \begin_layout Description
3957 Notion Used for buffer editation not for GUI control.
3958 \end_layout
3959 \begin_layout Description
3960 Syntax meta-prefix
3961 \end_layout
3962
3963 \begin_layout Subsection*
3964 LFUN_MOUSE_DOUBLE
3965 \end_layout
3966 \begin_layout Description
3967 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
3968 \end_layout
3969 \begin_layout Description
3970 Notion This is an internal LFUN, not to be used by users.
3971 \end_layout
3972 \begin_layout Description
3973 Origin Andre, 9 Aug 2002
3974 \end_layout
3975
3976 \begin_layout Subsection*
3977 LFUN_MOUSE_MOTION
3978 \end_layout
3979 \begin_layout Description
3980 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
3981 \end_layout
3982 \begin_layout Description
3983 Notion This is an internal LFUN, not to be used by users.
3984 \end_layout
3985 \begin_layout Description
3986 Origin Andre, 9 Aug 2002
3987 \end_layout
3988
3989 \begin_layout Subsection*
3990 LFUN_MOUSE_PRESS
3991 \end_layout
3992 \begin_layout Description
3993 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
3994 \end_layout
3995 \begin_layout Description
3996 Notion This is an internal LFUN, not to be used by users.
3997 \end_layout
3998 \begin_layout Description
3999 Origin Andre, 9 Aug 2002
4000 \end_layout
4001
4002 \begin_layout Subsection*
4003 LFUN_MOUSE_RELEASE
4004 \end_layout
4005 \begin_layout Description
4006 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4007 \end_layout
4008 \begin_layout Description
4009 Notion This is an internal LFUN, not to be used by users.
4010 \end_layout
4011 \begin_layout Description
4012 Origin Andre, 9 Aug 2002
4013 \end_layout
4014
4015 \begin_layout Subsection*
4016 LFUN_MOUSE_TRIPLE
4017 \end_layout
4018 \begin_layout Description
4019 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4020 \end_layout
4021 \begin_layout Description
4022 Notion This is an internal LFUN, not to be used by users.
4023 \end_layout
4024 \begin_layout Description
4025 Origin Andre, 9 Aug 2002
4026 \end_layout
4027
4028 \begin_layout Subsection*
4029 LFUN_NEWLINE_INSERT
4030 \end_layout
4031 \begin_layout Description
4032 Action Inserts a line break or new line.
4033 \end_layout
4034 \begin_layout Description
4035 Syntax newline-insert [<ARG>]
4036 \end_layout
4037 \begin_layout Description
4038 Params <ARG>: <newline|linebreak> default: newline
4039 \end_layout
4040 \begin_layout Description
4041 Origin JSpitzm, 25 Mar 2008
4042 \end_layout
4043
4044 \begin_layout Subsection*
4045 LFUN_NEWPAGE_INSERT
4046 \end_layout
4047 \begin_layout Description
4048 Action Inserts a new page.
4049 \end_layout
4050 \begin_layout Description
4051 Syntax newpage-insert <ARG>
4052 \end_layout
4053 \begin_layout Description
4054 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
4055 \end_layout
4056 \begin_layout Description
4057 Origin uwestoehr, 24 Nov 2007
4058 \end_layout
4059
4060 \begin_layout Subsection*
4061 LFUN_NOMENCLATURE_PRINT
4062 \end_layout
4063 \begin_layout Description
4064 Action Inserts list of Nomenclature entries.
4065 \end_layout
4066 \begin_layout Description
4067 Syntax nomenclature-print
4068 \end_layout
4069 \begin_layout Description
4070 Origin Ugras, 4 Nov 2006
4071 \end_layout
4072
4073 \begin_layout Subsection*
4074 LFUN_NOMENCL_INSERT
4075 \end_layout
4076 \begin_layout Description
4077 Action Inserts Nomenclature entry.
4078 \end_layout
4079 \begin_layout Description
4080 Notion It automatically takes the word on the cursor position if no symbol is given.
4081 \end_layout
4082 \begin_layout Description
4083 Syntax nomencl-insert [<SYMBOL>]
4084 \end_layout
4085 \begin_layout Description
4086 Origin Ugras, 4 Nov 2006
4087 \end_layout
4088
4089 \begin_layout Subsection*
4090 LFUN_NOTE_INSERT
4091 \end_layout
4092 \begin_layout Description
4093 Action Inserts Note on the current cursor position, move selection inside the inset.
4094 \end_layout
4095 \begin_layout Description
4096 Syntax note-insert [<TYPE>]
4097 \end_layout
4098 \begin_layout Description
4099 Params <TYPE>: <Note|Greyedout|Comment> default: Note
4100 \end_layout
4101
4102 \begin_layout Subsection*
4103 LFUN_NOTE_NEXT
4104 \end_layout
4105 \begin_layout Description
4106 Action Moves the cursor to the beginning of next Note inset.
4107 \end_layout
4108 \begin_layout Description
4109 Syntax note-next
4110 \end_layout
4111
4112 \begin_layout Subsection*
4113 LFUN_OUTLINE_DOWN
4114 \end_layout
4115 \begin_layout Description
4116 Action Move the current group in the downward direction in the structure of the document.
4117 \end_layout
4118 \begin_layout Description
4119 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
4120 \end_layout
4121 \begin_layout Description
4122 Syntax outline-down
4123 \end_layout
4124 \begin_layout Description
4125 Origin Vermeer, 23 Mar 2006
4126 \end_layout
4127
4128 \begin_layout Subsection*
4129 LFUN_OUTLINE_IN
4130 \end_layout
4131 \begin_layout Description
4132 Action Moves the current group in the downward direction in the hierarchy of the document structure.
4133 \end_layout
4134 \begin_layout Description
4135 Notion Part -> Chapter -> Section -> etc.
4136 \end_layout
4137 \begin_layout Description
4138 Syntax outline-in
4139 \end_layout
4140 \begin_layout Description
4141 Origin Vermeer, 23 Mar 2006
4142 \end_layout
4143
4144 \begin_layout Subsection*
4145 LFUN_OUTLINE_OUT
4146 \end_layout
4147 \begin_layout Description
4148 Action Moves the current group in the upward direction in the hierarchy of the document structure.
4149 \end_layout
4150 \begin_layout Description
4151 Notion Part <- Chapter <- Section <- etc.
4152 \end_layout
4153 \begin_layout Description
4154 Syntax outline-out
4155 \end_layout
4156 \begin_layout Description
4157 Origin Vermeer, 23 Mar 2006
4158 \end_layout
4159
4160 \begin_layout Subsection*
4161 LFUN_OUTLINE_UP
4162 \end_layout
4163 \begin_layout Description
4164 Action Move the current group in the upward direction in the structure of the document.
4165 \end_layout
4166 \begin_layout Description
4167 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
4168 \end_layout
4169 \begin_layout Description
4170 Syntax outline-up
4171 \end_layout
4172 \begin_layout Description
4173 Origin Vermeer, 23 Mar 2006
4174 \end_layout
4175
4176 \begin_layout Subsection*
4177 LFUN_PARAGRAPH_BREAK
4178 \end_layout
4179 \begin_layout Description
4180 Action Breaks the current paragraph at the current location.
4181 \end_layout
4182 \begin_layout Description
4183 Notion Removes the selection.
4184 \end_layout
4185 \begin_layout Description
4186 Syntax paragraph-break [<LAYOUT>]
4187 \end_layout
4188 \begin_layout Description
4189 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
4190 \end_layout
4191
4192 \begin_layout Subsection*
4193 LFUN_PARAGRAPH_DOWN
4194 \end_layout
4195 \begin_layout Description
4196 Action Move the cursor to the next paragraph (or beginning of the current one) in downward direction.
4197 \end_layout
4198 \begin_layout Description
4199 Syntax paragraph-down
4200 \end_layout
4201 \begin_layout Description
4202 Origin Asger, 1 Oct 1996
4203 \end_layout
4204
4205 \begin_layout Subsection*
4206 LFUN_PARAGRAPH_DOWN_SELECT
4207 \end_layout
4208 \begin_layout Description
4209 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in downward direction.
4210 \end_layout
4211 \begin_layout Description
4212 Syntax paragraph-down-select
4213 \end_layout
4214 \begin_layout Description
4215 Origin Asger, 1 Oct 1996
4216 \end_layout
4217
4218 \begin_layout Subsection*
4219 LFUN_PARAGRAPH_GOTO
4220 \end_layout
4221 \begin_layout Description
4222 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
4223 \end_layout
4224 \begin_layout Description
4225 Notion Note that id number of paragraph is not the sequential number of paragraph seen on the screen. Moreover the id is unique for all opened buffers (documents).
4226 \end_layout
4227 \begin_layout Description
4228 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
4229 \end_layout
4230 \begin_layout Description
4231 Params <PAR_ID_NUMBER>:  paragraph id
4232 \begin_inset Newline newline
4233 \end_inset
4234
4235 <POSITION_IN_PAR>: desired position within the paragraph
4236 \end_layout
4237 \begin_layout Description
4238 Origin Dekel, 26 Aug 2000
4239 \end_layout
4240
4241 \begin_layout Subsection*
4242 LFUN_PARAGRAPH_MOVE_DOWN
4243 \end_layout
4244 \begin_layout Description
4245 Action Moves the current paragraph downwards in the document.
4246 \end_layout
4247 \begin_layout Description
4248 Syntax paragraph-move-down
4249 \end_layout
4250 \begin_layout Description
4251 Origin Edwin, 8 Apr 2006
4252 \end_layout
4253
4254 \begin_layout Subsection*
4255 LFUN_PARAGRAPH_MOVE_UP
4256 \end_layout
4257 \begin_layout Description
4258 Action Moves the current paragraph upwards in the document.
4259 \end_layout
4260 \begin_layout Description
4261 Notion Movement through the document will possibly break the paragraph-depth (e.g. itemize structure).
4262 \end_layout
4263 \begin_layout Description
4264 Syntax paragraph-move-up
4265 \end_layout
4266 \begin_layout Description
4267 Origin Edwin, 8 Apr 2006
4268 \end_layout
4269
4270 \begin_layout Subsection*
4271 LFUN_PARAGRAPH_PARAMS
4272 \end_layout
4273 \begin_layout Description
4274 Action Change paragraph settings.
4275 \end_layout
4276 \begin_layout Description
4277 Notion Modifies the current paragraph, or currently selected paragraphs. This function only modifies, and does not override, existing settings. Note that the "leftindent" indent setting is deprecated.
4278 \end_layout
4279 \begin_layout Description
4280 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
4281 \end_layout
4282 \begin_layout Description
4283 Params <INDENT>:
4284 \backslash
4285 noindent|
4286 \backslash
4287 indent|
4288 \backslash
4289 indent-toggle|
4290 \backslash
4291 leftindent LENGTH
4292 \begin_inset Newline newline
4293 \end_inset
4294
4295 <SPACING>:
4296 \backslash
4297 paragraph_spacing default|single|onehalf|double|other SIZE
4298 \begin_inset Newline newline
4299 \end_inset
4300
4301 <ALIGN>:
4302 \backslash
4303 align block|left|right|center|default
4304 \begin_inset Newline newline
4305 \end_inset
4306
4307 <OTHERS>:
4308 \backslash
4309 labelwidthstring WIDTH|
4310 \backslash
4311 start_of_appendix
4312 \end_layout
4313 \begin_layout Description
4314 Origin rgh, Aug 15 2007
4315 \end_layout
4316
4317 \begin_layout Subsection*
4318 LFUN_PARAGRAPH_PARAMS_APPLY
4319 \end_layout
4320 \begin_layout Description
4321 Action Change paragraph settings.
4322 \end_layout
4323 \begin_layout Description
4324 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
4325 \end_layout
4326 \begin_layout Description
4327 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
4328 \end_layout
4329 \begin_layout Description
4330 Params For parameters see LFUN_PARAGRAPH_PARAMS
4331 \end_layout
4332 \begin_layout Description
4333 Origin leeming, 30 Mar 2004
4334 \end_layout
4335
4336 \begin_layout Subsection*
4337 LFUN_PARAGRAPH_UP
4338 \end_layout
4339 \begin_layout Description
4340 Action Move the cursor to the next paragraph (or beginning of the current one) in upward direction.
4341 \end_layout
4342 \begin_layout Description
4343 Syntax paragraph-up
4344 \end_layout
4345 \begin_layout Description
4346 Origin Asger, 1 Oct 1996
4347 \end_layout
4348
4349 \begin_layout Subsection*
4350 LFUN_PARAGRAPH_UPDATE
4351 \end_layout
4352 \begin_layout Description
4353 Action Updates the values inside the paragraph dialog from the paragraph.
4354 \end_layout
4355 \begin_layout Description
4356 Notion This is an internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
4357 \end_layout
4358 \begin_layout Description
4359 Origin leeming, 13 Mar 2003
4360 \end_layout
4361
4362 \begin_layout Subsection*
4363 LFUN_PARAGRAPH_UP_SELECT
4364 \end_layout
4365 \begin_layout Description
4366 Action Move the cursor and select the text to the next paragraph (or beginning of the current one) in upward direction.
4367 \end_layout
4368 \begin_layout Description
4369 Syntax paragraph-up-select
4370 \end_layout
4371 \begin_layout Description
4372 Origin Asger, 1 Oct 1996
4373 \end_layout
4374
4375 \begin_layout Subsection*
4376 LFUN_PASTE
4377 \end_layout
4378 \begin_layout Description
4379 Action Pastes material (text or picture) from the active clipboard.
4380 \end_layout
4381 \begin_layout Description
4382 Syntax paste [<TYPE>|<NUM>]
4383 \end_layout
4384 \begin_layout Description
4385 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf|latex|html
4386 \begin_inset Newline newline
4387 \end_inset
4388
4389 <NUM>: number of the selection in the internal clipboard stack to be pasted.
4390 \end_layout
4391
4392 \begin_layout Subsection*
4393 LFUN_PHANTOM_INSERT
4394 \end_layout
4395 \begin_layout Description
4396 Action Inserts phantom on the current cursor position, move selection inside the inset.
4397 \end_layout
4398 \begin_layout Description
4399 Syntax phantom-insert [<TYPE>]
4400 \end_layout
4401 \begin_layout Description
4402 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
4403 \end_layout
4404 \begin_layout Description
4405 Origin uwestoehr, 30 Jan 2009
4406 \end_layout
4407
4408 \begin_layout Subsection*
4409 LFUN_PREFERENCES_SAVE
4410 \end_layout
4411 \begin_layout Description
4412 Action Save user preferences.
4413 \end_layout
4414 \begin_layout Description
4415 Syntax preferences-save
4416 \end_layout
4417 \begin_layout Description
4418 Origin Lgb, 27 Nov 1999
4419 \end_layout
4420
4421 \begin_layout Subsection*
4422 LFUN_PREVIEW_INSERT
4423 \end_layout
4424 \begin_layout Description
4425 Action Inserts a new preview inset.
4426 \end_layout
4427 \begin_layout Description
4428 Syntax preview-insert
4429 \end_layout
4430 \begin_layout Description
4431 Origin vfr, 28 Mar 2010
4432 \end_layout
4433
4434 \begin_layout Subsection*
4435 LFUN_PRIMARY_SELECTION_PASTE
4436 \end_layout
4437 \begin_layout Description
4438 Action Pastes the currently selected text.
4439 \end_layout
4440 \begin_layout Description
4441 Notion Primary selection mechanism is linux-only thing.
4442 \end_layout
4443 \begin_layout Description
4444 Syntax primary-selection-paste [<ARG>]
4445 \end_layout
4446 \begin_layout Description
4447 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
4448 \end_layout
4449
4450 \begin_layout Subsection*
4451 LFUN_QUOTE_INSERT
4452 \end_layout
4453 \begin_layout Description
4454 Action Inserts quotes according to the type and quote-language preference.
4455 \end_layout
4456 \begin_layout Description
4457 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
4458 \end_layout
4459 \begin_layout Description
4460 Syntax quote-insert [<TYPE>]
4461 \end_layout
4462 \begin_layout Description
4463 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
4464 \end_layout
4465
4466 \begin_layout Subsection*
4467 LFUN_RECONFIGURE
4468 \end_layout
4469 \begin_layout Description
4470 Action Reconfigure the automatic settings.
4471 \end_layout
4472 \begin_layout Description
4473 Syntax reconfigure
4474 \end_layout
4475 \begin_layout Description
4476 Origin Asger, 14 Feb 1997
4477 \end_layout
4478
4479 \begin_layout Subsection*
4480 LFUN_REDO
4481 \end_layout
4482 \begin_layout Description
4483 Action Redoes the last thing undone.
4484 \end_layout
4485 \begin_layout Description
4486 Syntax redo
4487 \end_layout
4488
4489 \begin_layout Subsection*
4490 LFUN_REFERENCE_NEXT
4491 \end_layout
4492 \begin_layout Description
4493 Action Go to the next label or cross-reference.
4494 \end_layout
4495 \begin_layout Description
4496 Syntax reference-next
4497 \end_layout
4498 \begin_layout Description
4499 Origin Dekel, 14 Jan 2001
4500 \end_layout
4501
4502 \begin_layout Subsection*
4503 LFUN_REGEXP_MODE
4504 \end_layout
4505 \begin_layout Description
4506 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
4507 \end_layout
4508 \begin_layout Description
4509 Notion If there is any selected text, then it is moved inside the created regexp inset.
4510 \end_layout
4511 \begin_layout Description
4512 Syntax regexp-mode [<ARG>]
4513 \end_layout
4514 \begin_layout Description
4515 Params <ARG>: eventual argument (regular expression).
4516 \end_layout
4517 \begin_layout Description
4518 Origin Tommaso, 4 Oct 2008
4519 \end_layout
4520
4521 \begin_layout Subsection*
4522 LFUN_REPEAT
4523 \end_layout
4524 \begin_layout Description
4525 Action Repeat the given command.
4526 \end_layout
4527 \begin_layout Description
4528 Syntax repeat <COUNT> <LFUN-COMMAND>
4529 \end_layout
4530 \begin_layout Description
4531 Origin Andre, 27 Oct 2003
4532 \end_layout
4533
4534 \begin_layout Subsection*
4535 LFUN_SCREEN_DOWN
4536 \end_layout
4537 \begin_layout Description
4538 Action Moves the cursor one page in downward direction.
4539 \end_layout
4540 \begin_layout Description
4541 Syntax screen-down
4542 \end_layout
4543
4544 \begin_layout Subsection*
4545 LFUN_SCREEN_DOWN_SELECT
4546 \end_layout
4547 \begin_layout Description
4548 Action Moves the cursor one screen in downward direction adding the current position to the selection.
4549 \end_layout
4550 \begin_layout Description
4551 Syntax screen-down-select
4552 \end_layout
4553
4554 \begin_layout Subsection*
4555 LFUN_SCREEN_FONT_UPDATE
4556 \end_layout
4557 \begin_layout Description
4558 Action Update fonts and its metrics.
4559 \end_layout
4560 \begin_layout Description
4561 Notion Automatically called after zoom, dpi, font names, or norm change.
4562 \end_layout
4563 \begin_layout Description
4564 Syntax screen-font-update
4565 \end_layout
4566 \begin_layout Description
4567 Origin ARRae, 13 Aug 2000
4568 \end_layout
4569
4570 \begin_layout Subsection*
4571 LFUN_SCREEN_RECENTER
4572 \end_layout
4573 \begin_layout Description
4574 Action Recenters the screen on the current cursor position.
4575 \end_layout
4576 \begin_layout Description
4577 Syntax screen-recenter
4578 \end_layout
4579
4580 \begin_layout Subsection*
4581 LFUN_SCREEN_SHOW_CURSOR
4582 \end_layout
4583 \begin_layout Description
4584 Action Repositions the screen such that the cursor is visible.
4585 \end_layout
4586 \begin_layout Description
4587 Syntax screen-show-cursor
4588 \end_layout
4589 \begin_layout Description
4590 Origin vfr, 25 Mar 2009
4591 \end_layout
4592
4593 \begin_layout Subsection*
4594 LFUN_SCREEN_UP
4595 \end_layout
4596 \begin_layout Description
4597 Action Moves the cursor one page in upward direction.
4598 \end_layout
4599 \begin_layout Description
4600 Syntax screen-up
4601 \end_layout
4602
4603 \begin_layout Subsection*
4604 LFUN_SCREEN_UP_SELECT
4605 \end_layout
4606 \begin_layout Description
4607 Action Moves the cursor one page in upward direction adding the current position to the selection.
4608 \end_layout
4609 \begin_layout Description
4610 Syntax screen-up-select
4611 \end_layout
4612
4613 \begin_layout Subsection*
4614 LFUN_SCRIPT_INSERT
4615 \end_layout
4616 \begin_layout Description
4617 Action Inserts a subscript or superscript inset.
4618 \end_layout
4619 \begin_layout Description
4620 Syntax script-insert <TYPE>
4621 \end_layout
4622 \begin_layout Description
4623 Params <TYPE>: subscript|superscript
4624 \end_layout
4625 \begin_layout Description
4626 Origin Georg, 23 Nov 2010
4627 \end_layout
4628
4629 \begin_layout Subsection*
4630 LFUN_SCROLL
4631 \end_layout
4632 \begin_layout Description
4633 Action Scroll the buffer view.
4634 \end_layout
4635 \begin_layout Description
4636 Notion Only scrolls the screen up or down; does not move the cursor.
4637 \end_layout
4638 \begin_layout Description
4639 Syntax scroll <TYPE> <QUANTITY>
4640 \end_layout
4641 \begin_layout Description
4642 Params <TYPE>:  line|page
4643 \begin_inset Newline newline
4644 \end_inset
4645
4646 <QUANTITY>: up|down|<number>
4647 \end_layout
4648 \begin_layout Description
4649 Origin Abdel, Dec 27 2007
4650 \end_layout
4651
4652 \begin_layout Subsection*
4653 LFUN_SECTION_SELECT
4654 \end_layout
4655 \begin_layout Description
4656 Action Selects the whole section.
4657 \end_layout
4658 \begin_layout Description
4659 Notion The cursor should be in a section heading before calling this lfun.
4660 \end_layout
4661 \begin_layout Description
4662 Syntax section-select
4663 \end_layout
4664 \begin_layout Description
4665 Origin vfr, 05 May 2009
4666 \end_layout
4667
4668 \begin_layout Subsection*
4669 LFUN_SELECTION_PASTE
4670 \end_layout
4671 \begin_layout Description
4672 Action Pastes the internal selection text in permanent selection.
4673 \end_layout
4674 \begin_layout Description
4675 Notion Created in order to have middle mouse button pasting correct (bound to command-alternatives selection-paste ; primary-selection-paste paragraph).
4676 \end_layout
4677 \begin_layout Description
4678 Syntax selection-paste
4679 \end_layout
4680 \begin_layout Description
4681 Origin lasgouttes, 14 Jan 2009
4682 \end_layout
4683
4684 \begin_layout Subsection*
4685 LFUN_SELF_INSERT
4686 \end_layout
4687 \begin_layout Description
4688 Action Inserts the given string (accordingly to the correct keymap).
4689 \end_layout
4690 \begin_layout Description
4691 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
4692 \end_layout
4693 \begin_layout Description
4694 Syntax self-insert <STRING>
4695 \end_layout
4696
4697 \begin_layout Subsection*
4698 LFUN_SERVER_GET_FILENAME
4699 \end_layout
4700 \begin_layout Description
4701 Action Returns path and file name of the currently edited document.
4702 \end_layout
4703 \begin_layout Description
4704 Syntax server-get-filename
4705 \end_layout
4706
4707 \begin_layout Subsection*
4708 LFUN_SERVER_GET_LAYOUT
4709 \end_layout
4710 \begin_layout Description
4711 Action Returns the current layout (that is environment) name on the cursor position.
4712 \end_layout
4713 \begin_layout Description
4714 Syntax server-get-layout
4715 \end_layout
4716
4717 \begin_layout Subsection*
4718 LFUN_SERVER_GET_XY
4719 \end_layout
4720 \begin_layout Description
4721 Action Returns the coordinates of cursor position in the editing area.
4722 \end_layout
4723 \begin_layout Description
4724 Syntax server-get-xy
4725 \end_layout
4726
4727 \begin_layout Subsection*
4728 LFUN_SERVER_GOTO_FILE_ROW
4729 \end_layout
4730 \begin_layout Description
4731 Action Sets the cursor position in LyX based on the row number of generated TeX file.
4732 \end_layout
4733 \begin_layout Description
4734 Notion This can be useful for DVI inverse-search or detection of the problematic line from LaTeX compilation. Note that before this function can be used export to LaTeX output must occur (in order to map the row numbers).
4735 \end_layout
4736 \begin_layout Description
4737 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4738 \end_layout
4739 \begin_layout Description
4740 Params <FILE>: the path and filename. Environment variables are expanded in the path. In case this LFUN does not work make sure you are giving correct path to the file.
4741 \begin_inset Newline newline
4742 \end_inset
4743
4744 If the file is located inside LyX temporary directory it will be mapped back into the appropriate opened buffer (e.g. for the case of generated .tex file).
4745 \begin_inset Newline newline
4746 \end_inset
4747
4748 .ext: extensions will be automatically replaced by .lyx.
4749 \begin_inset Newline newline
4750 \end_inset
4751
4752 <ROW_NUMBER> The row number of the LaTeX file to which to go.
4753 \end_layout
4754 \begin_layout Description
4755 Sample server-goto-file-row /home/user/example.lyx 41
4756 \begin_inset Newline newline
4757 \end_inset
4758
4759 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
4760 \end_layout
4761 \begin_layout Description
4762 Origin Edmar, 23 Dec 1998
4763 \end_layout
4764
4765 \begin_layout Subsection*
4766 LFUN_SERVER_NOTIFY
4767 \end_layout
4768 \begin_layout Description
4769 Action Sends notify message about the last key-sequence to client.
4770 \end_layout
4771 \begin_layout Description
4772 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4773 \end_layout
4774 \begin_layout Description
4775 Syntax server-notify
4776 \end_layout
4777
4778 \begin_layout Subsection*
4779 LFUN_SERVER_SET_XY
4780 \end_layout
4781 \begin_layout Description
4782 Action Sets the cursor position based on the editing area coordinates (similar to clicking on that point with left mouse button).
4783 \end_layout
4784 \begin_layout Description
4785 Syntax server-set-xy <X> <Y>
4786 \end_layout
4787
4788 \begin_layout Subsection*
4789 LFUN_SET_COLOR
4790 \end_layout
4791 \begin_layout Description
4792 Action Set the given LyX color to the color defined by the X11 name given.
4793 \end_layout
4794 \begin_layout Description
4795 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4796 \end_layout
4797 \begin_layout Description
4798 Syntax set-color <LYX_NAME> <X11_NAME>
4799 \end_layout
4800 \begin_layout Description
4801 Origin SLior, 11 Jun 2000
4802 \end_layout
4803
4804 \begin_layout Subsection*
4805 LFUN_SET_GRAPHICS_GROUP
4806 \end_layout
4807 \begin_layout Description
4808 Action Set the group for the graphics inset on the cursor position.
4809 \end_layout
4810 \begin_layout Description
4811 Syntax set-graphics-group [<GROUP>]
4812 \end_layout
4813 \begin_layout Description
4814 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
4815 \end_layout
4816 \begin_layout Description
4817 Origin sanda, 6 May 2008
4818 \end_layout
4819
4820 \begin_layout Subsection*
4821 LFUN_SPACE_INSERT
4822 \end_layout
4823 \begin_layout Description
4824 Action Inserts one of horizontal space insets.
4825 \end_layout
4826 \begin_layout Description
4827 Syntax space-insert <NAME> [<LEN>]
4828 \end_layout
4829 \begin_layout Description
4830 Params <NAME>: normal, protected, visible, thin, quad, qquad, enspace, enskip, negthinspace, negmedspace, negthickspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
4831 \begin_inset Newline newline
4832 \end_inset
4833
4834 Only in math mode: med and thick.
4835 \begin_inset Newline newline
4836 \end_inset
4837
4838 <LEN>: length for custom spaces (hspace, hspace* for protected)
4839 \end_layout
4840 \begin_layout Description
4841 Origin JSpitzm, 20 May 2003, Mar 17 2008
4842 \end_layout
4843
4844 \begin_layout Subsection*
4845 LFUN_SPECIALCHAR_INSERT
4846 \end_layout
4847 \begin_layout Description
4848 Action Inserts various characters into the document.
4849 \end_layout
4850 \begin_layout Description
4851 Syntax specialchar-insert <CHAR>
4852 \end_layout
4853 \begin_layout Description
4854 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
4855 \end_layout
4856 \begin_layout Description
4857 Origin JSpitzm, 6 Dec 2007
4858 \end_layout
4859
4860 \begin_layout Subsection*
4861 LFUN_SPELLING_ADD
4862 \end_layout
4863 \begin_layout Description
4864 Action Add the word under the cursor to the respective spell checker dictionary.
4865 \end_layout
4866 \begin_layout Description
4867 Syntax spelling-add [<STRING>] [<LANG>]
4868 \end_layout
4869 \begin_layout Description
4870 Params <WORD>: word to add <LANG>: language name (see file languages)
4871 \end_layout
4872 \begin_layout Description
4873 Origin JSpitzm, 18 Jan 2010
4874 \end_layout
4875
4876 \begin_layout Subsection*
4877 LFUN_SPELLING_CONTINUOUSLY
4878 \end_layout
4879 \begin_layout Description
4880 Action Toggle continuous spell checking.
4881 \end_layout
4882 \begin_layout Description
4883 Syntax spelling-continuously
4884 \end_layout
4885 \begin_layout Description
4886 Origin vfr, 24 March 2013
4887 \end_layout
4888
4889 \begin_layout Subsection*
4890 LFUN_SPELLING_IGNORE
4891 \end_layout
4892 \begin_layout Description
4893 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
4894 \end_layout
4895 \begin_layout Description
4896 Syntax spelling-ignore [<WORD>] [<LANG>]
4897 \end_layout
4898 \begin_layout Description
4899 Params <WORD>: word to ignore <LANG>: language name (see file languages)
4900 \end_layout
4901 \begin_layout Description
4902 Origin JSpitzm, 18 Jan 2010
4903 \end_layout
4904
4905 \begin_layout Subsection*
4906 LFUN_SPELLING_REMOVE
4907 \end_layout
4908 \begin_layout Description
4909 Action Remove the word under the cursor from the respective spell checker dictionary.
4910 \end_layout
4911 \begin_layout Description
4912 Syntax spelling-remove [<STRING>] [<LANG>]
4913 \end_layout
4914 \begin_layout Description
4915 Params <WORD>: word to remove <LANG>: language name (see file languages)
4916 \end_layout
4917 \begin_layout Description
4918 Origin SWitt, 28 July 2010
4919 \end_layout
4920
4921 \begin_layout Subsection*
4922 LFUN_STATISTICS
4923 \end_layout
4924 \begin_layout Description
4925 Action Count the statistics (number of words and characters) in the document or in the given selection.
4926 \end_layout
4927 \begin_layout Description
4928 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4929 \end_layout
4930 \begin_layout Description
4931 Syntax statistics
4932 \end_layout
4933 \begin_layout Description
4934 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4935 \end_layout
4936
4937 \begin_layout Subsection*
4938 LFUN_TABULAR_INSERT
4939 \end_layout
4940 \begin_layout Description
4941 Action Inserts table into the document.
4942 \end_layout
4943 \begin_layout Description
4944 Notion See LFUN_INSET_MODIFY for some more details about tabular modifications.
4945 \end_layout
4946 \begin_layout Description
4947 Syntax tabular-insert [<ROWS> <COLUMNS>]
4948 \end_layout
4949 \begin_layout Description
4950 Params In case no arguments are given show insert dialog.
4951 \end_layout
4952 \begin_layout Description
4953 Origin Jug, 12 Apr 2000
4954 \end_layout
4955
4956 \begin_layout Subsection*
4957 LFUN_TAB_DELETE
4958 \end_layout
4959 \begin_layout Description
4960 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
4961 \end_layout
4962 \begin_layout Description
4963 Notion It also works on a selection - it removes a tab or spaces from the beginning of each line spanned by the selection. This is useful if you want to indent/unindent multiple lines in one action.
4964 \end_layout
4965 \begin_layout Description
4966 Syntax tab-delete
4967 \end_layout
4968 \begin_layout Description
4969 Origin vfr, Sep 30 2008
4970 \end_layout
4971
4972 \begin_layout Subsection*
4973 LFUN_TAB_GROUP_CLOSE
4974 \end_layout
4975 \begin_layout Description
4976 Action Close the current tab group.
4977 \end_layout
4978 \begin_layout Description
4979 Notion This only closes the work areas, not the buffers themselves. The still opened buffers can be visualized in another tab group.
4980 \end_layout
4981 \begin_layout Description
4982 Syntax tab-group-close
4983 \end_layout
4984 \begin_layout Description
4985 Origin Abdel, 21 Feb 2008
4986 \end_layout
4987
4988 \begin_layout Subsection*
4989 LFUN_TAB_INSERT
4990 \end_layout
4991 \begin_layout Description
4992 Action Insert a tab into a listings inset.
4993 \end_layout
4994 \begin_layout Description
4995 Notion It also works on a selection.
4996 \end_layout
4997 \begin_layout Description
4998 Syntax tab-insert
4999 \end_layout
5000 \begin_layout Description
5001 Origin vfr, Sep 30 2008
5002 \end_layout
5003
5004 \begin_layout Subsection*
5005 LFUN_TEXTCLASS_APPLY
5006 \end_layout
5007 \begin_layout Description
5008 Action Sets the text class for the current buffer.
5009 \end_layout
5010 \begin_layout Description
5011 Syntax textclass-apply <TEXTCLASS>
5012 \end_layout
5013 \begin_layout Description
5014 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
5015 \end_layout
5016
5017 \begin_layout Subsection*
5018 LFUN_TEXTCLASS_LOAD
5019 \end_layout
5020 \begin_layout Description
5021 Action Loads information for a textclass from disk.
5022 \end_layout
5023 \begin_layout Description
5024 Syntax textclass-load <TEXTCLASS>
5025 \end_layout
5026 \begin_layout Description
5027 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
5028 \end_layout
5029
5030 \begin_layout Subsection*
5031 LFUN_TEXTSTYLE_APPLY
5032 \end_layout
5033 \begin_layout Description
5034 Action Toggle user-defined (=last-time used) text style.
5035 \end_layout
5036 \begin_layout Description
5037 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically triggered when using Text Style dialog.
5038 \end_layout
5039 \begin_layout Description
5040 Syntax textstyle-apply
5041 \end_layout
5042 \begin_layout Description
5043 Origin leeming, 12 Mar 2003
5044 \end_layout
5045
5046 \begin_layout Subsection*
5047 LFUN_TEXTSTYLE_UPDATE
5048 \end_layout
5049 \begin_layout Description
5050 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
5051 \end_layout
5052 \begin_layout Description
5053 Syntax textstyle-update <FONT_INFO>
5054 \end_layout
5055 \begin_layout Description
5056 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
5057 \begin_inset Newline newline
5058 \end_inset
5059
5060 Use lyx -dbg action for exact syntax of text-style dialog parameters.
5061 \end_layout
5062 \begin_layout Description
5063 Origin leeming, 12 Mar 2003
5064 \end_layout
5065
5066 \begin_layout Subsection*
5067 LFUN_THESAURUS_ENTRY
5068 \end_layout
5069 \begin_layout Description
5070 Action Look up thesaurus entries with respect to the word under the cursor.
5071 \end_layout
5072 \begin_layout Description
5073 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
5074 \end_layout
5075 \begin_layout Description
5076 Params <STRING>: word to look up <LANG>: language (see file languages)
5077 \end_layout
5078 \begin_layout Description
5079 Origin Levon, 20 Jul 2001
5080 \end_layout
5081
5082 \begin_layout Subsection*
5083 LFUN_TOOLBAR_TOGGLE
5084 \end_layout
5085 \begin_layout Description
5086 Action Toggles visibility of a given toolbar between on/off/auto.
5087 \end_layout
5088 \begin_layout Description
5089 Notion Skipping "auto" when allowauto is false.
5090 \end_layout
5091 \begin_layout Description
5092 Syntax toolbar-toggle <NAME> [allowauto]
5093 \end_layout
5094 \begin_layout Description
5095 Params <NAME>: standard|extra|table|math|mathmacrotemplate|
5096 \begin_inset Newline newline
5097 \end_inset
5098
5099 minibuffer|review|view/update|math_panels|vcs| view-others|update-others
5100 \end_layout
5101 \begin_layout Description
5102 Origin Edwin, 21 May 2007
5103 \end_layout
5104
5105 \begin_layout Subsection*
5106 LFUN_UI_TOGGLE
5107 \end_layout
5108 \begin_layout Description
5109 Action Various UI visibility-toggling actions.
5110 \end_layout
5111 \begin_layout Description
5112 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
5113 \end_layout
5114 \begin_layout Description
5115 Params statusbar  : Toggle visibility of the statusbar.
5116 \begin_inset Newline newline
5117 \end_inset
5118
5119 menubar    : Toggle visibility of the menubar.
5120 \begin_inset Newline newline
5121 \end_inset
5122
5123 scrollbar  : Toggle visibility of the scrollbar.
5124 \begin_inset Newline newline
5125 \end_inset
5126
5127 frame      : Toggle visibility of the frames around editing window.
5128 \begin_inset Newline newline
5129 \end_inset
5130
5131 fullscreen : Toggle fullscreen mode. This also covers calling the previous functions. However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should be used.
5132 \end_layout
5133 \begin_layout Description
5134 Origin sanda, 9 Feb 2007
5135 \end_layout
5136
5137 \begin_layout Subsection*
5138 LFUN_UNDO
5139 \end_layout
5140 \begin_layout Description
5141 Action Undoes the last edit.
5142 \end_layout
5143 \begin_layout Description
5144 Syntax undo
5145 \end_layout
5146
5147 \begin_layout Subsection*
5148 LFUN_UNICODE_INSERT
5149 \end_layout
5150 \begin_layout Description
5151 Action Inserts a single unicode character.
5152 \end_layout
5153 \begin_layout Description
5154 Syntax unicode-insert <CHAR>
5155 \end_layout
5156 \begin_layout Description
5157 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
5158 \end_layout
5159 \begin_layout Description
5160 Sample unicode-insert 0x0100
5161 \end_layout
5162 \begin_layout Description
5163 Origin Lgb, 22 Oct 2006
5164 \end_layout
5165
5166 \begin_layout Subsection*
5167 LFUN_UP
5168 \end_layout
5169 \begin_layout Description
5170 Action Moves the cursor one line in upward direction.
5171 \end_layout
5172 \begin_layout Description
5173 Syntax up
5174 \end_layout
5175
5176 \begin_layout Subsection*
5177 LFUN_UP_SELECT
5178 \end_layout
5179 \begin_layout Description
5180 Action Moves the cursor one line in upward direction adding the current position to the selection.
5181 \end_layout
5182 \begin_layout Description
5183 Syntax up-select
5184 \end_layout
5185
5186 \begin_layout Subsection*
5187 LFUN_VC_CHECK_IN
5188 \end_layout
5189 \begin_layout Description
5190 Action Checks-in/commits the changes of the registered file to the repository.
5191 \end_layout
5192 \begin_layout Description
5193 Notion In RCS case this also unlocks the file.
5194 \end_layout
5195 \begin_layout Description
5196 Syntax vc-check-in
5197 \end_layout
5198 \begin_layout Description
5199 Origin Lgb, 1 Jul 1997
5200 \end_layout
5201
5202 \begin_layout Subsection*
5203 LFUN_VC_CHECK_OUT
5204 \end_layout
5205 \begin_layout Description
5206 Action Checks-out the document for edit (and locks it in some cases).
5207 \end_layout
5208 \begin_layout Description
5209 Syntax vc-check-out
5210 \end_layout
5211 \begin_layout Description
5212 Origin Lgb, 1 Jul 1997
5213 \end_layout
5214
5215 \begin_layout Subsection*
5216 LFUN_VC_COMMAND
5217 \end_layout
5218 \begin_layout Description
5219 Action Executes external command. This command is intended to support additional VCS commands.
5220 \end_layout
5221 \begin_layout Description
5222 Syntax vc-command <FLAG> <PATH> <COMMAND>
5223 \end_layout
5224 \begin_layout Description
5225 Params  <FLAG>: Flags for the command can be combined together.
5226 \begin_inset Newline newline
5227 \end_inset
5228
5229 U - dUmmy - no flags
5230 \begin_inset Newline newline
5231 \end_inset
5232
5233 D - Doc - need document loaded to proceed
5234 \begin_inset Newline newline
5235 \end_inset
5236
5237 I - dIrty - mark document dirty
5238 \begin_inset Newline newline
5239 \end_inset
5240
5241 R - Reload - ensure that the document is saved and reload it after command execution
5242 \begin_inset Newline newline
5243 \end_inset
5244
5245 M - Message - ask for input string (commit message)
5246 \begin_inset Newline newline
5247 \end_inset
5248
5249 <PATH>: path where to start. $$p will be replaced by the current document path.
5250 \begin_inset Newline newline
5251 \end_inset
5252
5253 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
5254 \end_layout
5255 \begin_layout Description
5256 Sample vc-command DR $$p "svn up"
5257 \end_layout
5258 \begin_layout Description
5259 Origin sanda, 13 Jan 2009
5260 \end_layout
5261
5262 \begin_layout Subsection*
5263 LFUN_VC_COMPARE
5264 \end_layout
5265 \begin_layout Description
5266 Action Compares two revisions of the same file under version control.
5267 \end_layout
5268 \begin_layout Description
5269 Syntax vc-compare [<REV1>] [<REV2>]
5270 \end_layout
5271 \begin_layout Description
5272 Params Revision number either points directly to commit in history or if negative number -x it points to (last commit - x).
5273 \begin_inset Newline newline
5274 \end_inset
5275
5276                In RCS we subtract only in the last number of revision specification. Special case "0" is reserved for the last committed revision.
5277 \begin_inset Newline newline
5278 \end_inset
5279
5280 <REV1>: Older file.
5281 \begin_inset Newline newline
5282 \end_inset
5283
5284                <REV2>: Newer file. Used only if REV1 > 0.
5285 \begin_inset Newline newline
5286 \end_inset
5287
5288 If no parameter is given, interactive dialog will be shown.
5289 \end_layout
5290 \begin_layout Description
5291 Sample Compare current document against last commit
5292 \begin_inset Newline newline
5293 \end_inset
5294
5295                vc-compare 0
5296 \begin_inset Newline newline
5297 \end_inset
5298
5299 Compare current document against current revision - 5 commits
5300 \begin_inset Newline newline
5301 \end_inset
5302
5303                vc-compare -5
5304 \begin_inset Newline newline
5305 \end_inset
5306
5307 Compare revisions 120 and 155
5308 \begin_inset Newline newline
5309 \end_inset
5310
5311                vc-compare 120 155
5312 \end_layout
5313 \begin_layout Description
5314 Origin sanda, 12 Feb 2010
5315 \end_layout
5316
5317 \begin_layout Subsection*
5318 LFUN_VC_COPY
5319 \end_layout
5320 \begin_layout Description
5321 Action Copies the document to another name.
5322 \end_layout
5323 \begin_layout Description
5324 Notion Copying with revision history is only supported by SVN. For RCS and CVS it is simulated by adding the document under a new name. Disabled if uncommitted changes exist.
5325 \end_layout
5326 \begin_layout Description
5327 Syntax vc-copy <FILENAME>
5328 \end_layout
5329 \begin_layout Description
5330 Params <FILENAME>: New name of the document.
5331 \begin_inset Newline newline
5332 \end_inset
5333
5334 A file dialog is opened if no filename is given.
5335 \end_layout
5336 \begin_layout Description
5337 Origin gb, 05 Feb 2013
5338 \end_layout
5339
5340 \begin_layout Subsection*
5341 LFUN_VC_LOCKING_TOGGLE
5342 \end_layout
5343 \begin_layout Description
5344 Action Toggles the locking property of the edited file.
5345 \end_layout
5346 \begin_layout Description
5347 Notion This is currently implemented only for SVN.
5348 \end_layout
5349 \begin_layout Description
5350 Syntax vc-locking-toggle
5351 \end_layout
5352 \begin_layout Description
5353 Origin sanda, 25 Jun 2009
5354 \end_layout
5355
5356 \begin_layout Subsection*
5357 LFUN_VC_REGISTER
5358 \end_layout
5359 \begin_layout Description
5360 Action Register the document as an file inside version control system.
5361 \end_layout
5362 \begin_layout Description
5363 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
5364 \begin_inset Newline newline
5365 \end_inset
5366
5367 See LyX Additional Features Manual (Version Control Chapter) for additional information.
5368 \end_layout
5369 \begin_layout Description
5370 Syntax vc-register
5371 \end_layout
5372 \begin_layout Description
5373 Origin Lgb, 1 Jul 1997
5374 \end_layout
5375
5376 \begin_layout Subsection*
5377 LFUN_VC_RENAME
5378 \end_layout
5379 \begin_layout Description
5380 Action Renames the document to another name.
5381 \end_layout
5382 \begin_layout Description
5383 Notion Renaming with revision history is only supported by SVN. For CVS it is simulated by adding the document under a new name and deleting the old one. For RCS it is not supported. Disabled if uncommitted changes exist.
5384 \end_layout
5385 \begin_layout Description
5386 Syntax vc-rename <FILENAME>
5387 \end_layout
5388 \begin_layout Description
5389 Params <FILENAME>: New name of the document.
5390 \begin_inset Newline newline
5391 \end_inset
5392
5393 A file dialog is opened if no filename is given.
5394 \end_layout
5395 \begin_layout Description
5396 Origin gb, 05 Feb 2013
5397 \end_layout
5398
5399 \begin_layout Subsection*
5400 LFUN_VC_REPO_UPDATE
5401 \end_layout
5402 \begin_layout Description
5403 Action Update the local archive directory in which resides the current document with the remote repository.
5404 \end_layout
5405 \begin_layout Description
5406 Syntax vc-repo-update
5407 \end_layout
5408 \begin_layout Description
5409 Origin sanda, 16 Oct 2009
5410 \end_layout
5411
5412 \begin_layout Subsection*
5413 LFUN_VC_REVERT
5414 \end_layout
5415 \begin_layout Description
5416 Action Reverts the document to the last check-in/commit in VCS.
5417 \end_layout
5418 \begin_layout Description
5419 Syntax vc-revert
5420 \end_layout
5421 \begin_layout Description
5422 Origin Lgb, 1 Jul 1997
5423 \end_layout
5424
5425 \begin_layout Subsection*
5426 LFUN_VC_UNDO_LAST
5427 \end_layout
5428 \begin_layout Description
5429 Action Undo last check-in.
5430 \end_layout
5431 \begin_layout Description
5432 Notion This is currently implemented only for RCS.
5433 \end_layout
5434 \begin_layout Description
5435 Syntax vc-check-out
5436 \end_layout
5437 \begin_layout Description
5438 Origin Lgb, 1 Jul 1997
5439 \end_layout
5440
5441 \begin_layout Subsection*
5442 LFUN_VIEW_CLOSE
5443 \end_layout
5444 \begin_layout Description
5445 Action Close the current document work area.
5446 \end_layout
5447 \begin_layout Description
5448 Notion Close the current work area. If no other work areas are showing the buffer, then close the associated buffer as well.
5449 \end_layout
5450 \begin_layout Description
5451 Syntax view-close
5452 \end_layout
5453 \begin_layout Description
5454 Origin Tommaso, 15 Sep 2012
5455 \end_layout
5456
5457 \begin_layout Subsection*
5458 LFUN_VIEW_SPLIT
5459 \end_layout
5460 \begin_layout Description
5461 Action Creates another split view of current buffer.
5462 \end_layout
5463 \begin_layout Description
5464 Notion All split views act in the same way independently.
5465 \end_layout
5466 \begin_layout Description
5467 Syntax view-split <vertical|horizontal>
5468 \end_layout
5469 \begin_layout Description
5470 Params horizontal : The work areas are laid out side by side.
5471 \begin_inset Newline newline
5472 \end_inset
5473
5474 vertical   : The work areas laid out vertically.
5475 \end_layout
5476 \begin_layout Description
5477 Origin Abdel, 20 Feb 2008
5478 \end_layout
5479
5480 \begin_layout Subsection*
5481 LFUN_WINDOW_CLOSE
5482 \end_layout
5483 \begin_layout Description
5484 Action Closes the current LyX window.
5485 \end_layout
5486 \begin_layout Description
5487 Syntax window-close
5488 \end_layout
5489 \begin_layout Description
5490 Origin Abdel, 23 Oct 2006
5491 \end_layout
5492
5493 \begin_layout Subsection*
5494 LFUN_WINDOW_NEW
5495 \end_layout
5496 \begin_layout Description
5497 Action Creates new empty LyX window.
5498 \end_layout
5499 \begin_layout Description
5500 Notion Already opened documents from the previous window can be found under View menu.
5501 \end_layout
5502 \begin_layout Description
5503 Syntax window-new [<GEOMETRY>]
5504 \end_layout
5505 \begin_layout Description
5506 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
5507 \end_layout
5508 \begin_layout Description
5509 Origin Abdel, 21 Oct 2006
5510 \end_layout
5511
5512 \begin_layout Subsection*
5513 LFUN_WORD_BACKWARD
5514 \end_layout
5515 \begin_layout Description
5516 Action Moves the cursor to the logically previous beginning of a word.
5517 \end_layout
5518 \begin_layout Description
5519 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_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
5520 \end_layout
5521 \begin_layout Description
5522 Syntax word-backward
5523 \end_layout
5524
5525 \begin_layout Subsection*
5526 LFUN_WORD_BACKWARD_SELECT
5527 \end_layout
5528 \begin_layout Description
5529 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
5530 \end_layout
5531 \begin_layout Description
5532 Notion See also LFUN_WORD_BACKWARD.
5533 \end_layout
5534 \begin_layout Description
5535 Syntax word-backward-select
5536 \end_layout
5537
5538 \begin_layout Subsection*
5539 LFUN_WORD_CAPITALIZE
5540 \end_layout
5541 \begin_layout Description
5542 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
5543 \end_layout
5544 \begin_layout Description
5545 Syntax word-capitalize
5546 \end_layout
5547
5548 \begin_layout Subsection*
5549 LFUN_WORD_DELETE_BACKWARD
5550 \end_layout
5551 \begin_layout Description
5552 Action Deletes characters to the beginning of the word (usually the "C+BackSpace" key).
5553 \end_layout
5554 \begin_layout Description
5555 Syntax word-delete-backward
5556 \end_layout
5557
5558 \begin_layout Subsection*
5559 LFUN_WORD_DELETE_FORWARD
5560 \end_layout
5561 \begin_layout Description
5562 Action Deletes characters to the end of the word (usually the "C+Delete" key).
5563 \end_layout
5564 \begin_layout Description
5565 Syntax word-delete-forward
5566 \end_layout
5567
5568 \begin_layout Subsection*
5569 LFUN_WORD_FIND
5570 \end_layout
5571 \begin_layout Description
5572 Action Search for next occurrence of a string.
5573 \end_layout
5574 \begin_layout Description
5575 Syntax word-find [<DATA>]
5576 \end_layout
5577 \begin_layout Description
5578 Params <DATA>: data encoded from Find dialog (see lyx::find2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
5579 \end_layout
5580 \begin_layout Description
5581 Origin Andre, Jan 7 2004
5582 \end_layout
5583
5584 \begin_layout Subsection*
5585 LFUN_WORD_FINDADV
5586 \end_layout
5587 \begin_layout Description
5588 Action Search for next occurrence of a pattern.
5589 \end_layout
5590 \begin_layout Description
5591 Syntax word-findadv [<DATA>]
5592 \end_layout
5593 \begin_layout Description
5594 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()). If no parameter is given, search with last find-dialog data is used for search (i.e. find-next).
5595 \end_layout
5596 \begin_layout Description
5597 Origin Tommaso, Nov 15 2007
5598 \end_layout
5599
5600 \begin_layout Subsection*
5601 LFUN_WORD_FIND_BACKWARD
5602 \end_layout
5603 \begin_layout Description
5604 Action Search for a given string in backward direction.
5605 \end_layout
5606 \begin_layout Description
5607 Notion Case sensitive, match words. If no argument given, last search repeated.
5608 \end_layout
5609 \begin_layout Description
5610 Syntax word-find-backward [<STRING>]
5611 \end_layout
5612 \begin_layout Description
5613 Origin Etienne, 20 Feb 1998
5614 \end_layout
5615
5616 \begin_layout Subsection*
5617 LFUN_WORD_FIND_FORWARD
5618 \end_layout
5619 \begin_layout Description
5620 Action Search for a given string in forward direction.
5621 \end_layout
5622 \begin_layout Description
5623 Notion Case sensitive, match words. If no argument given, last search repeated.
5624 \end_layout
5625 \begin_layout Description
5626 Syntax word-find-forward [<STRING>]
5627 \end_layout
5628 \begin_layout Description
5629 Origin Etienne, 16 Feb 1998
5630 \end_layout
5631
5632 \begin_layout Subsection*
5633 LFUN_WORD_FORWARD
5634 \end_layout
5635 \begin_layout Description
5636 Action Moves the cursor to the logically next beginning of a word.
5637 \end_layout
5638 \begin_layout Description
5639 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_WORD_LEFT or LFUN_WORD_RIGHT actions, which in turn may employ this one.
5640 \end_layout
5641 \begin_layout Description
5642 Syntax word-forward
5643 \end_layout
5644
5645 \begin_layout Subsection*
5646 LFUN_WORD_FORWARD_SELECT
5647 \end_layout
5648 \begin_layout Description
5649 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
5650 \end_layout
5651 \begin_layout Description
5652 Notion See also LFUN_WORD_FORWARD.
5653 \end_layout
5654 \begin_layout Description
5655 Syntax word-forward-select
5656 \end_layout
5657
5658 \begin_layout Subsection*
5659 LFUN_WORD_LEFT
5660 \end_layout
5661 \begin_layout Description
5662 Action Moves the cursor to the next beginning of a word "on the left".
5663 \end_layout
5664 \begin_layout Description
5665 Notion This is the action which should be taken when the (e.g., ctrl-) "left" key is pressed. Generally, it moves the cursor to the next beginning of a word on 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.
5666 \end_layout
5667 \begin_layout Description
5668 Syntax word-left
5669 \end_layout
5670 \begin_layout Description
5671 Origin dov, 28 Oct 2007
5672 \end_layout
5673
5674 \begin_layout Subsection*
5675 LFUN_WORD_LEFT_SELECT
5676 \end_layout
5677 \begin_layout Description
5678 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
5679 \end_layout
5680 \begin_layout Description
5681 Notion See also LFUN_WORD_LEFT for exact details of the movement.
5682 \end_layout
5683 \begin_layout Description
5684 Syntax word-left-select
5685 \end_layout
5686 \begin_layout Description
5687 Origin dov, 28 Oct 2007
5688 \end_layout
5689
5690 \begin_layout Subsection*
5691 LFUN_WORD_LOWCASE
5692 \end_layout
5693 \begin_layout Description
5694 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
5695 \end_layout
5696 \begin_layout Description
5697 Syntax word-lowcase
5698 \end_layout
5699
5700 \begin_layout Subsection*
5701 LFUN_WORD_REPLACE
5702 \end_layout
5703 \begin_layout Description
5704 Action Replace a string in the document.
5705 \end_layout
5706 \begin_layout Description
5707 Syntax word-replace [<DATA>]
5708 \end_layout
5709 \begin_layout Description
5710 Params <DATA>: data is of the form "<replace>
5711 \begin_inset Newline newline
5712 \end_inset
5713
5714 <search>
5715 \begin_inset Newline newline
5716 \end_inset
5717
5718 <casesensitive> <matchword> <all> <forward> <findnext>"
5719 \end_layout
5720 \begin_layout Description
5721 Origin Andre, Jan 7 2004
5722 \end_layout
5723
5724 \begin_layout Subsection*
5725 LFUN_WORD_RIGHT
5726 \end_layout
5727 \begin_layout Description
5728 Action Moves the cursor to the next beginning of a word "on the right".
5729 \end_layout
5730 \begin_layout Description
5731 Notion This is the action which should be taken when the (e.g., ctrl-) "right" key is pressed. Generally, it moves the cursor to the next beginning of a word on 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.
5732 \end_layout
5733 \begin_layout Description
5734 Syntax word-right
5735 \end_layout
5736 \begin_layout Description
5737 Origin dov, 28 Oct 2007
5738 \end_layout
5739
5740 \begin_layout Subsection*
5741 LFUN_WORD_RIGHT_SELECT
5742 \end_layout
5743 \begin_layout Description
5744 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
5745 \end_layout
5746 \begin_layout Description
5747 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
5748 \end_layout
5749 \begin_layout Description
5750 Syntax word-right-select
5751 \end_layout
5752 \begin_layout Description
5753 Origin dov, 28 Oct 2007
5754 \end_layout
5755
5756 \begin_layout Subsection*
5757 LFUN_WORD_SELECT
5758 \end_layout
5759 \begin_layout Description
5760 Action Puts the word where the cursor stands into the selection.
5761 \end_layout
5762 \begin_layout Description
5763 Syntax word-select
5764 \end_layout
5765 \begin_layout Description
5766 Origin Andre, 11 Sep 2002
5767 \end_layout
5768
5769 \begin_layout Subsection*
5770 LFUN_WORD_UPCASE
5771 \end_layout
5772 \begin_layout Description
5773 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
5774 \end_layout
5775 \begin_layout Description
5776 Syntax word-upcase
5777 \end_layout
5778
5779 \begin_layout Subsection*
5780 LFUN_WRAP_INSERT
5781 \end_layout
5782 \begin_layout Description
5783 Action Inserts floats wrapped by the text around.
5784 \end_layout
5785 \begin_layout Description
5786 Syntax wrap-insert <TYPE>
5787 \end_layout
5788 \begin_layout Description
5789 Params <TYPE>: table|figure
5790 \end_layout
5791 \begin_layout Description
5792 Origin Dekel, 7 Apr 2002
5793 \end_layout
5794
5795 \end_body
5796 \end_document