lib/doc/LFUNs.lyx

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