lib/doc/LFUNs.lyx

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