lib/doc/LFUNs.lyx

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