lib/doc/LFUNs.lyx

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