lib/doc/LFUNs.lyx

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