lib/doc/LFUNs.lyx

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