1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
6 \use_default_options false
14 \font_typewriter default
15 \font_default_family default
22 \paperfontsize default
30 \paperorientation portrait
37 \paragraph_separation indent
39 \quotes_language english
42 \paperpagestyle default
43 \tracking_changes false
51 \begin_layout Section*
52 LFUNs documentation automatically generated 2009-07-25
55 \begin_layout Standard
59 \begin_layout Plain Layout
69 \begin_inset VSpace 1cm
74 \begin_layout Subsection*
77 \begin_layout Description
78 Action Adds an acute accent to the next character typed.
80 \begin_layout Description
84 \begin_layout Subsection*
87 \begin_layout Description
88 Action Adds a breve accent to the next character typed.
90 \begin_layout Description
94 \begin_layout Subsection*
97 \begin_layout Description
98 Action Adds a caron to the next character typed.
100 \begin_layout Description
104 \begin_layout Subsection*
107 \begin_layout Description
108 Action Adds a cedilla to the next character typed.
110 \begin_layout Description
111 Syntax accent-cedilla
114 \begin_layout Subsection*
117 \begin_layout Description
118 Action Adds a circle accent to the next character typed.
120 \begin_layout Description
124 \begin_layout Subsection*
125 LFUN_ACCENT_CIRCUMFLEX
127 \begin_layout Description
128 Action Adds a circumflex to the next character typed.
130 \begin_layout Description
131 Syntax accent-circumflex
134 \begin_layout Subsection*
137 \begin_layout Description
138 Action Adds a dot accent to the next character typed.
140 \begin_layout Description
144 \begin_layout Subsection*
147 \begin_layout Description
148 Action Adds a grave accent to the next character typed.
150 \begin_layout Description
154 \begin_layout Subsection*
155 LFUN_ACCENT_HUNGARIAN_UMLAUT
157 \begin_layout Description
158 Action Adds a Hungarian umlaut to the next character typed.
160 \begin_layout Description
164 \begin_layout Subsection*
167 \begin_layout Description
168 Action Adds a macron to the next character typed.
170 \begin_layout Description
174 \begin_layout Subsection*
177 \begin_layout Description
178 Action Adds an ogonek accent to the next character typed.
180 \begin_layout Description
184 \begin_layout Subsection*
187 \begin_layout Description
188 Action Adds a tie over the next two character typed.
190 \begin_layout Description
191 Notion The following char will finish the tie.
193 \begin_layout Description
197 \begin_layout Subsection*
200 \begin_layout Description
201 Action Adds a tilde over the next character typed.
203 \begin_layout Description
207 \begin_layout Subsection*
210 \begin_layout Description
211 Action Adds an umlaut over the next character typed.
213 \begin_layout Description
217 \begin_layout Subsection*
220 \begin_layout Description
221 Action Adds a bar under the next character typed.
223 \begin_layout Description
224 Syntax accent-underbar
227 \begin_layout Subsection*
230 \begin_layout Description
231 Action Adds a dot under the next character typed.
233 \begin_layout Description
234 Syntax accent-underdot
237 \begin_layout Subsection*
240 \begin_layout Description
241 Action Inserts a caption inset.
243 \begin_layout Description
244 Syntax caption-insert
246 \begin_layout Description
247 Origin Lgb, 18 Jul 2000
250 \begin_layout Subsection*
253 \begin_layout Description
254 Action Inserts the current date.
256 \begin_layout Description
257 Syntax date-insert [<ARG>]
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.
262 \begin_layout Description
263 Origin jdblair, 31 Jan 2000
266 \begin_layout Subsection*
269 \begin_layout Description
270 Action Inserts a footnote inset.
272 \begin_layout Description
273 Syntax footnote-insert
275 \begin_layout Description
276 Origin Jug, 7 Mar 2000
279 \begin_layout Subsection*
282 \begin_layout Description
283 Action Inserts an ERT inset.
285 \begin_layout Description
288 \begin_layout Description
289 Origin Jug, 18 Feb 2000
292 \begin_layout Subsection*
295 \begin_layout Description
296 Action Inserts a float inset.
298 \begin_layout Description
299 Syntax float-insert <TYPE>
301 \begin_layout Description
302 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
304 \begin_layout Description
305 Origin Lgb, 27 Jun 2000
308 \begin_layout Subsection*
309 LFUN_FLOAT_WIDE_INSERT
311 \begin_layout Description
312 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
314 \begin_layout Description
315 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
317 \begin_layout Description
318 Syntax float-wide-insert <TYPE>
320 \begin_layout Description
321 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
323 \begin_layout Description
324 Origin Lgb, 31 Oct 2001
327 \begin_layout Subsection*
328 LFUN_FLOAT_LIST_INSERT
330 \begin_layout Description
331 Action Inserts the list of floats in the document.
333 \begin_layout Description
334 Syntax float-list-insert <TYPE>
336 \begin_layout Description
337 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
339 \begin_layout Description
340 Origin Lgb, 3 May 2001
343 \begin_layout Subsection*
346 \begin_layout Description
347 Action Inserts floats wrapped by the text around.
349 \begin_layout Description
350 Syntax wrap-insert <TYPE>
352 \begin_layout Description
353 Params <TYPE>: table|figure
355 \begin_layout Description
356 Origin Dekel, 7 Apr 2002
359 \begin_layout Subsection*
362 \begin_layout Description
363 Action Inserts an optional-argument (short title) inset.
365 \begin_layout Description
366 Syntax optional-insert
368 \begin_layout Description
369 Origin vermeer, 12 Aug 2002
372 \begin_layout Subsection*
375 \begin_layout Description
376 Action Inserts a horizontal line.
378 \begin_layout Description
381 \begin_layout Description
382 Origin Andre, Oct 27 2003
385 \begin_layout Subsection*
388 \begin_layout Description
389 Action Inserts a new page.
391 \begin_layout Description
392 Syntax newpage-insert <ARG>
394 \begin_layout Description
395 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
397 \begin_layout Description
398 Origin uwestoehr, 24 Nov 2007
401 \begin_layout Subsection*
402 LFUN_MARGINALNOTE_INSERT
404 \begin_layout Description
405 Action Inserts a marginal note.
407 \begin_layout Description
408 Syntax marginalnote-insert
410 \begin_layout Description
411 Origin Lgb, 26 Jun 2000
414 \begin_layout Subsection*
417 \begin_layout Description
418 Action Inserts a single unicode character.
420 \begin_layout Description
421 Syntax unicode-insert <CHAR>
423 \begin_layout Description
424 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
426 \begin_layout Description
427 Sample unicode-insert 0x0100
429 \begin_layout Description
430 Origin Lgb, 22 Oct 2006
433 \begin_layout Subsection*
436 \begin_layout Description
437 Action Inserts a new listings inset.
439 \begin_layout Description
440 Syntax listing-insert
442 \begin_layout Description
443 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
446 \begin_layout Subsection*
449 \begin_layout Description
450 Action Insert a tab into a listings inset.
452 \begin_layout Description
453 Notion It also works on a selection.
455 \begin_layout Description
458 \begin_layout Description
459 Origin vfr, Sep 30 2008
462 \begin_layout Subsection*
465 \begin_layout Description
466 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
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.
471 \begin_layout Description
474 \begin_layout Description
475 Origin vfr, Sep 30 2008
478 \begin_layout Subsection*
481 \begin_layout Description
482 Action Inserts quotes according to the type and quote-language preference.
484 \begin_layout Description
485 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
487 \begin_layout Description
488 Syntax quote-insert [<TYPE>]
490 \begin_layout Description
491 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
494 \begin_layout Subsection*
497 \begin_layout Description
498 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
500 \begin_layout Description
501 Notion Apart from lfun arguments you can use the following method:
502 \begin_inset Newline newline
505 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
506 \begin_inset Newline newline
509 2. select the text and run info-insert lfun.
511 \begin_layout Description
512 Syntax info-insert <TYPE> <ARG>
514 \begin_layout Description
515 Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
516 \begin_inset Newline newline
519 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
520 \begin_inset Newline newline
523 shortcut[s]: name of lfun (e.g math-insert
526 \begin_inset Newline newline
529 lyxrc: name of rc_entry (e.g. bind_file)
530 \begin_inset Newline newline
533 package: name of latex package (e.g. listings)
534 \begin_inset Newline newline
537 textclass: name of textclass (e.g. article)
538 \begin_inset Newline newline
541 menu: name of lfun used in menu
542 \begin_inset Newline newline
545 icon: name of lfun used in toolbar
546 \begin_inset Newline newline
549 buffer: "name"|"path"|"class"
551 \begin_layout Description
552 Sample command-sequence info-insert buffer path; info-insert buffer name
554 \begin_layout Description
555 Origin bpeng, 7 Oct 2007
558 \begin_layout Subsection*
561 \begin_layout Description
562 Action Inserts branch inset.
564 \begin_layout Description
565 Syntax branch-insert <BRANCH-NAME>
567 \begin_layout Description
568 Origin vermeer, 17 Aug 2003
571 \begin_layout Subsection*
574 \begin_layout Description
575 Action Inserts Box inset.
577 \begin_layout Description
578 Syntax box-insert [<TYPE>]
580 \begin_layout Description
581 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
582 \begin_inset Newline newline
585 Framed is the default one.
587 \begin_layout Description
588 Origin vermeer, 7 Oct 2003
591 \begin_layout Subsection*
594 \begin_layout Description
595 Action Inserts CharStyle, Custom inset or XML short element.
597 \begin_layout Description
598 Notion Look into the Customization manual for more information about these elements.
599 \begin_inset Newline newline
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
606 For dissolving the element see LFUN_INSET_DISSOLVE.
608 \begin_layout Description
609 Syntax flex-insert <TYPE:Name>
611 \begin_layout Description
612 Params TYPE: CharStyle|Custom|Element|Standard
613 \begin_inset Newline newline
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
620 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
622 \begin_layout Description
623 Sample flex-insert CharStyle:Code
626 \begin_layout Subsection*
629 \begin_layout Description
630 Action Inserts the given string (accordingly to the correct keymap).
632 \begin_layout Description
633 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
635 \begin_layout Description
636 Syntax self-insert <STRING>
639 \begin_layout Subsection*
642 \begin_layout Description
643 Action Inserts one of horizontal space insets.
645 \begin_layout Description
646 Syntax space-insert <NAME> [<LEN>]
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
653 <LEN>: length for custom spaces (hspace, hspace* for protected)
655 \begin_layout Description
656 Origin JSpitzm, 20 May 2003, Mar 17 2008
659 \begin_layout Subsection*
660 LFUN_HYPERLINK_INSERT
662 \begin_layout Description
663 Action Inserts hyperlinks into the document (clickable in pdf output).
665 \begin_layout Description
666 Notion Hyperlink target can be set via selection + hyperlink-insert function.
668 \begin_layout Description
669 Syntax href-insert [<TARGET>]
671 \begin_layout Description
672 Origin CFO-G, 21 Nov 1997
675 \begin_layout Subsection*
676 LFUN_SPECIALCHAR_INSERT
678 \begin_layout Description
679 Action Inserts various characters into the document.
681 \begin_layout Description
682 Syntax specialchar-insert <CHAR>
684 \begin_layout Description
685 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
687 \begin_layout Description
688 Origin JSpitzm, 6 Dec 2007
691 \begin_layout Subsection*
694 \begin_layout Description
695 Action Inserts table of contents.
697 \begin_layout Description
700 \begin_layout Description
701 Origin Lgb, 27 May 97
704 \begin_layout Subsection*
707 \begin_layout Description
708 Action Start (or remove) Appendix on the given cursor position.
710 \begin_layout Description
713 \begin_layout Description
714 Origin ettrich, 5 May 1998
717 \begin_layout Subsection*
720 \begin_layout Description
721 Action Inserts Index entry.
723 \begin_layout Description
724 Notion It automatically takes the word on the cursor position.
726 \begin_layout Description
727 Syntax index-insert [<TYPE:Name>]
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.
732 \begin_layout Description
733 Origin leeming, 3 Aug 2000
736 \begin_layout Subsection*
739 \begin_layout Description
740 Action Inserts list of Index entries on a new page.
742 \begin_layout Description
743 Syntax index-print [<TYPE:Name>]
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.
748 \begin_layout Description
749 Origin Lgb, 27 Feb 1997
752 \begin_layout Subsection*
755 \begin_layout Description
756 Action Inserts Nomenclature entry.
758 \begin_layout Description
759 Notion It automatically takes the word on the cursor position if no symbol is given.
761 \begin_layout Description
762 Syntax nomencl-insert [<SYMBOL>]
764 \begin_layout Description
765 Origin Ugras, 4 Nov 2006
768 \begin_layout Subsection*
769 LFUN_NOMENCLATURE_PRINT
771 \begin_layout Description
772 Action Inserts list of Nomenclature entries.
774 \begin_layout Description
775 Syntax nomenclature-print
777 \begin_layout Description
778 Origin Ugras, 4 Nov 2006
781 \begin_layout Subsection*
784 \begin_layout Description
785 Action Inserts Note on the current cursor postion, move selection inside the inset.
787 \begin_layout Description
788 Syntax note-insert [<TYPE>]
790 \begin_layout Description
791 Params <TYPE>: <Note|Greyedout|Comment> default: Note
794 \begin_layout Subsection*
797 \begin_layout Description
798 Action Moves the cursor to the begining of next Note inset.
800 \begin_layout Description
804 \begin_layout Subsection*
807 \begin_layout Description
808 Action Changes all Note insets of a particular type (source) to a different type (target) fot the current document.
810 \begin_layout Description
811 Syntax notes-mutate <SOURCE> <TARGET>
813 \begin_layout Description
814 Params <SOURCE/TARGET>: Note|Comment|Greyedout
816 \begin_layout Description
817 Origin sanda, 18 Jun 2008
820 \begin_layout Subsection*
823 \begin_layout Description
824 Action Inserts phantom on the current cursor postion, move selection inside the inset.
826 \begin_layout Description
827 Syntax phantom-insert [<TYPE>]
829 \begin_layout Description
830 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
832 \begin_layout Description
833 Origin uwestoehr, 30 Jan 2009
836 \begin_layout Subsection*
839 \begin_layout Description
840 Action Inserts a line break or new line.
842 \begin_layout Description
843 Syntax newline-insert [<ARG>]
845 \begin_layout Description
846 Params <ARG>: <newline|linebreak> default: newline
848 \begin_layout Description
849 Origin JSpitzm, 25 Mar 2008
852 \begin_layout Subsection*
855 \begin_layout Description
856 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
858 \begin_layout Description
861 \begin_layout Description
862 Origin Lgb, 17 May 2001
865 \begin_layout Subsection*
868 \begin_layout Description
869 Action Moves the cursor one line in downward direction.
871 \begin_layout Description
875 \begin_layout Subsection*
878 \begin_layout Description
879 Action Moves the cursor one line in upward direction.
881 \begin_layout Description
885 \begin_layout Subsection*
888 \begin_layout Description
889 Action Moves the cursor one line in downward direction adding the current position to the selection.
891 \begin_layout Description
895 \begin_layout Subsection*
898 \begin_layout Description
899 Action Moves the cursor one line in upward direction adding the current position to the selection.
901 \begin_layout Description
905 \begin_layout Subsection*
908 \begin_layout Description
909 Action Moves the cursor one page in downward direction.
911 \begin_layout Description
915 \begin_layout Subsection*
918 \begin_layout Description
919 Action Moves the cursor one page in upward direction.
921 \begin_layout Description
925 \begin_layout Subsection*
926 LFUN_SCREEN_DOWN_SELECT
928 \begin_layout Description
929 Action Moves the cursor one screen in downward direction adding the current position to the selection.
931 \begin_layout Description
932 Syntax screen-down-select
935 \begin_layout Subsection*
936 LFUN_SCREEN_UP_SELECT
938 \begin_layout Description
939 Action Moves the cursor one page in upward direction adding the current position to the selection.
941 \begin_layout Description
942 Syntax screen-up-select
945 \begin_layout Subsection*
948 \begin_layout Description
949 Action Scroll the buffer view.
951 \begin_layout Description
952 Notion Only scrolls the screen up or down; does not move the cursor.
954 \begin_layout Description
955 Syntax scroll <TYPE> <QUANTITY>
957 \begin_layout Description
958 Params <TYPE>: line|page
959 \begin_inset Newline newline
962 <QUANTITY>: up|down|<number>
964 \begin_layout Description
965 Origin Abdel, Dec 27 2007
968 \begin_layout Subsection*
971 \begin_layout Description
972 Action Recenters the screen on the current cursor position.
974 \begin_layout Description
975 Syntax screen-recenter
978 \begin_layout Subsection*
979 LFUN_SCREEN_SHOW_CURSOR
981 \begin_layout Description
982 Action Repositions the screen such that the cursor is visible.
984 \begin_layout Description
985 Syntax screen-show-cursor
987 \begin_layout Description
988 Origin vfr, 25 Mar 2009
991 \begin_layout Subsection*
994 \begin_layout Description
995 Action Moves the cursor one position logically backwards.
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.
1000 \begin_layout Description
1001 Syntax char-backward
1004 \begin_layout Subsection*
1005 LFUN_CHAR_BACKWARD_SELECT
1007 \begin_layout Description
1008 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1010 \begin_layout Description
1011 Notion See also LFUN_CHAR_BACKWARD.
1013 \begin_layout Description
1014 Syntax char-backward-select
1017 \begin_layout Subsection*
1018 LFUN_CHAR_DELETE_BACKWARD
1020 \begin_layout Description
1021 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1023 \begin_layout Description
1024 Syntax char-delete-backward
1027 \begin_layout Subsection*
1028 LFUN_CHAR_DELETE_FORWARD
1030 \begin_layout Description
1031 Action Deletes one character in the backward direction (usually the "Delete" key).
1033 \begin_layout Description
1034 Syntax char-delete-forward
1037 \begin_layout Subsection*
1040 \begin_layout Description
1041 Action Moves the cursor one position logically forward.
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.
1046 \begin_layout Description
1050 \begin_layout Subsection*
1051 LFUN_CHAR_FORWARD_SELECT
1053 \begin_layout Description
1054 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1056 \begin_layout Description
1057 Notion See also LFUN_CHAR_FORWARD.
1059 \begin_layout Description
1060 Syntax char-forward-select
1063 \begin_layout Subsection*
1066 \begin_layout Description
1067 Action Moves the cursor one position "to the left".
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.
1072 \begin_layout Description
1076 \begin_layout Subsection*
1077 LFUN_CHAR_LEFT_SELECT
1079 \begin_layout Description
1080 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1082 \begin_layout Description
1083 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1085 \begin_layout Description
1086 Syntax char-left-select
1089 \begin_layout Subsection*
1092 \begin_layout Description
1093 Action Moves the cursor one position "to the right".
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.
1098 \begin_layout Description
1102 \begin_layout Subsection*
1103 LFUN_CHAR_RIGHT_SELECT
1105 \begin_layout Description
1106 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1108 \begin_layout Description
1109 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1111 \begin_layout Description
1112 Syntax char-right-select
1115 \begin_layout Subsection*
1118 \begin_layout Description
1119 Action Moves the cursor to the logically previous beginning of a word.
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.
1124 \begin_layout Description
1125 Syntax word-backward
1128 \begin_layout Subsection*
1129 LFUN_WORD_BACKWARD_SELECT
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.
1134 \begin_layout Description
1135 Notion See also LFUN_WORD_BACKWARD.
1137 \begin_layout Description
1138 Syntax word-backward-select
1141 \begin_layout Subsection*
1142 LFUN_WORD_DELETE_BACKWARD
1144 \begin_layout Description
1145 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1147 \begin_layout Description
1148 Syntax word-delete-backward
1151 \begin_layout Subsection*
1152 LFUN_WORD_DELETE_FORWARD
1154 \begin_layout Description
1155 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1157 \begin_layout Description
1158 Syntax word-delete-forward
1161 \begin_layout Subsection*
1162 LFUN_WORD_FIND_FORWARD
1164 \begin_layout Description
1165 Action Search for a given string in forward direction.
1167 \begin_layout Description
1168 Notion Case sensitive, match words. If no argument given, last search repeated.
1170 \begin_layout Description
1171 Syntax word-find-forward [<STRING>]
1173 \begin_layout Description
1174 Origin Etienne, 16 Feb 1998
1177 \begin_layout Subsection*
1178 LFUN_WORD_FIND_BACKWARD
1180 \begin_layout Description
1181 Action Search for a given string in backward direction.
1183 \begin_layout Description
1184 Notion Case sensitive, match words. If no argument given, last search repeated.
1186 \begin_layout Description
1187 Syntax word-find-backward [<STRING>]
1189 \begin_layout Description
1190 Origin Etienne, 20 Feb 1998
1193 \begin_layout Subsection*
1196 \begin_layout Description
1197 Action Search for next occurence of a string.
1199 \begin_layout Description
1200 Syntax word-find [<DATA>]
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).
1205 \begin_layout Description
1206 Origin Andre, Jan 7 2004
1209 \begin_layout Subsection*
1212 \begin_layout Description
1213 Action Replace a string in the document.
1215 \begin_layout Description
1216 Syntax word-replace [<DATA>]
1218 \begin_layout Description
1219 Params <DATA>: data is of the form "<replace>
1220 \begin_inset Newline newline
1224 \begin_inset Newline newline
1227 <casesensitive> <matchword> <all> <forward>"
1229 \begin_layout Description
1230 Origin Andre, Jan 7 2004
1233 \begin_layout Subsection*
1236 \begin_layout Description
1237 Action Search for next occurence of a pattern.
1239 \begin_layout Description
1240 Syntax word-findadv [<DATA>]
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).
1245 \begin_layout Description
1246 Origin Tommaso, Nov 15 2007
1249 \begin_layout Subsection*
1252 \begin_layout Description
1253 Action Moves the cursor to the logically next beginning of a word.
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.
1258 \begin_layout Description
1262 \begin_layout Subsection*
1263 LFUN_WORD_FORWARD_SELECT
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.
1268 \begin_layout Description
1269 Notion See also LFUN_WORD_FORWARD.
1271 \begin_layout Description
1272 Syntax word-forward-select
1275 \begin_layout Subsection*
1278 \begin_layout Description
1279 Action Moves the cursor to the next beginning of a word "on the left".
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.
1284 \begin_layout Description
1287 \begin_layout Description
1288 Origin dov, 28 Oct 2007
1291 \begin_layout Subsection*
1292 LFUN_WORD_LEFT_SELECT
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.
1297 \begin_layout Description
1298 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1300 \begin_layout Description
1301 Syntax word-left-select
1303 \begin_layout Description
1304 Origin dov, 28 Oct 2007
1307 \begin_layout Subsection*
1310 \begin_layout Description
1311 Action Moves the cursor to the next beginning of a word "on the right".
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.
1316 \begin_layout Description
1319 \begin_layout Description
1320 Origin dov, 28 Oct 2007
1323 \begin_layout Subsection*
1324 LFUN_WORD_RIGHT_SELECT
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.
1329 \begin_layout Description
1330 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1332 \begin_layout Description
1333 Syntax word-right-select
1335 \begin_layout Description
1336 Origin dov, 28 Oct 2007
1339 \begin_layout Subsection*
1342 \begin_layout Description
1343 Action Puts the word where the cursor stands into the selection.
1345 \begin_layout Description
1348 \begin_layout Description
1349 Origin Andre, 11 Sep 2002
1352 \begin_layout Subsection*
1353 LFUN_WORD_CAPITALIZE
1355 \begin_layout Description
1356 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1358 \begin_layout Description
1359 Syntax word-capitalize
1362 \begin_layout Subsection*
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.
1368 \begin_layout Description
1372 \begin_layout Subsection*
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.
1378 \begin_layout Description
1382 \begin_layout Subsection*
1383 LFUN_THESAURUS_ENTRY
1385 \begin_layout Description
1386 Action Look up thesaurus entries with respect to the word under the cursor.
1388 \begin_layout Description
1389 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1391 \begin_layout Description
1392 Params <STRING>: word to look up <LANG>: language (see file languages)
1394 \begin_layout Description
1395 Origin Levon, 20 Jul 2001
1398 \begin_layout Subsection*
1401 \begin_layout Description
1402 Action Move the cursor to the beginning of the document.
1404 \begin_layout Description
1408 \begin_layout Subsection*
1409 LFUN_BUFFER_BEGIN_SELECT
1411 \begin_layout Description
1412 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1414 \begin_layout Description
1415 Syntax buffer-begin-select
1418 \begin_layout Subsection*
1421 \begin_layout Description
1422 Action Move the cursor to the end of the document.
1424 \begin_layout Description
1428 \begin_layout Subsection*
1429 LFUN_BUFFER_END_SELECT
1431 \begin_layout Description
1432 Action Move the cursor to the end of the document adding the traversed text to the selection.
1434 \begin_layout Description
1435 Syntax buffer-end-select
1438 \begin_layout Subsection*
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
1444 \begin_layout Description
1447 \begin_layout Description
1448 Origin lasgouttes, 16 Mar 2009
1451 \begin_layout Subsection*
1452 LFUN_INSET_BEGIN_SELECT
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).
1457 \begin_layout Description
1458 Syntax inset-begin-select
1460 \begin_layout Description
1461 Origin lasgouttes, 16 Mar 2009
1464 \begin_layout Subsection*
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
1470 \begin_layout Description
1473 \begin_layout Description
1474 Origin lasgouttes, 16 Mar 2009
1477 \begin_layout Subsection*
1478 LFUN_INSET_END_SELECT
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).
1483 \begin_layout Description
1484 Syntax inset-end-select
1486 \begin_layout Description
1487 Origin lasgouttes, 16 Mar 2009
1490 \begin_layout Subsection*
1493 \begin_layout Description
1494 Action Move the cursor to the begining of the (screen) line.
1496 \begin_layout Description
1500 \begin_layout Subsection*
1501 LFUN_LINE_BEGIN_SELECT
1503 \begin_layout Description
1504 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1506 \begin_layout Description
1507 Syntax line-begin-select
1510 \begin_layout Subsection*
1513 \begin_layout Description
1514 Action Move the cursor to the end of the (screen) line.
1516 \begin_layout Description
1520 \begin_layout Subsection*
1521 LFUN_LINE_END_SELECT
1523 \begin_layout Description
1524 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1526 \begin_layout Description
1527 Syntax line-end-select
1530 \begin_layout Subsection*
1533 \begin_layout Description
1534 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1536 \begin_layout Description
1537 Syntax line-delete-forward
1540 \begin_layout Subsection*
1543 \begin_layout Description
1544 Action Copies to the clipboard the last edit.
1546 \begin_layout Description
1550 \begin_layout Subsection*
1553 \begin_layout Description
1554 Action Cuts to the clipboard.
1556 \begin_layout Description
1560 \begin_layout Subsection*
1563 \begin_layout Description
1564 Action Pastes material (text or picture) from the active clipboard.
1566 \begin_layout Description
1567 Syntax paste [<TYPE>|<NUM>]
1569 \begin_layout Description
1570 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1571 \begin_inset Newline newline
1574 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1577 \begin_layout Subsection*
1578 LFUN_CLIPBOARD_PASTE
1580 \begin_layout Description
1581 Action Pastes text from the active clipboard.
1583 \begin_layout Description
1584 Syntax clipboard-paste [<ARG>]
1586 \begin_layout Description
1587 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1589 \begin_layout Description
1590 Origin baum, 10 Jul 2006
1593 \begin_layout Subsection*
1594 LFUN_PRIMARY_SELECTION_PASTE
1596 \begin_layout Description
1597 Action Pastes the currently text selected text.
1599 \begin_layout Description
1600 Notion Primary selection mechanism is linux-only thing.
1602 \begin_layout Description
1603 Syntax primary-selection-paste [<ARG>]
1605 \begin_layout Description
1606 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1609 \begin_layout Subsection*
1610 LFUN_SELECTION_PASTE
1612 \begin_layout Description
1613 Action Pastes the text in permanent selection.
1615 \begin_layout Description
1616 Syntax selection-paste
1619 \begin_layout Subsection*
1622 \begin_layout Description
1623 Action Undoes the last edit.
1625 \begin_layout Description
1629 \begin_layout Subsection*
1632 \begin_layout Description
1633 Action Redoes the last thing undone.
1635 \begin_layout Description
1639 \begin_layout Subsection*
1642 \begin_layout Description
1643 Action Repeat the given command.
1645 \begin_layout Description
1646 Syntax repeat <COUNT> <LFUN-COMMAND>
1648 \begin_layout Description
1649 Origin Andre, 27 Oct 2003
1652 \begin_layout Subsection*
1653 LFUN_CHARS_TRANSPOSE
1655 \begin_layout Description
1656 Action Transposes the character at the cursor with the one before it.
1658 \begin_layout Description
1659 Syntax chars-transpose
1661 \begin_layout Description
1662 Origin Lgb, 25 Apr 2001
1665 \begin_layout Subsection*
1666 LFUN_DEPTH_DECREMENT
1668 \begin_layout Description
1669 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1671 \begin_layout Description
1672 Syntax depth-decrement
1675 \begin_layout Subsection*
1676 LFUN_DEPTH_INCREMENT
1678 \begin_layout Description
1679 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1681 \begin_layout Description
1682 Syntax depth-increment
1685 \begin_layout Subsection*
1688 \begin_layout Description
1689 Action Toggles the bold font (selection-wise) using mathbf in math.
1691 \begin_layout Description
1695 \begin_layout Subsection*
1696 LFUN_FONT_BOLDSYMBOL
1698 \begin_layout Description
1699 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1701 \begin_layout Description
1702 Syntax font-boldsymbol
1705 \begin_layout Subsection*
1706 LFUN_FONT_TYPEWRITER
1708 \begin_layout Description
1709 Action Toggles the typewriter family font (selection-wise).
1711 \begin_layout Description
1712 Syntax font-typewriter
1715 \begin_layout Subsection*
1718 \begin_layout Description
1719 Action Toggles underline in the font (selection-wise).
1721 \begin_layout Description
1722 Syntax font-underline
1725 \begin_layout Subsection*
1728 \begin_layout Description
1729 Action Toggles double underline in the font (selection-wise).
1731 \begin_layout Description
1732 Syntax font-underunderline
1734 \begin_layout Description
1735 Origin sanda, 5 May 2009
1738 \begin_layout Subsection*
1741 \begin_layout Description
1742 Action Toggles wavy underline in the font (selection-wise).
1744 \begin_layout Description
1745 Syntax font-underwave
1747 \begin_layout Description
1748 Origin sanda, 5 May 2009
1751 \begin_layout Subsection*
1754 \begin_layout Description
1755 Action Toggles strikeout (strike-through) in the font (selection-wise).
1757 \begin_layout Description
1758 Syntax font-strikeout
1760 \begin_layout Description
1761 Origin sanda, 3 May 2009
1764 \begin_layout Subsection*
1767 \begin_layout Description
1768 Action Toggles the emphasis font style (selection-wise).
1770 \begin_layout Description
1774 \begin_layout Subsection*
1777 \begin_layout Description
1778 Action Toggles Noun text style font (selection-wise).
1780 \begin_layout Description
1784 \begin_layout Subsection*
1787 \begin_layout Description
1788 Action Toggles Roman family font (selection-wise).
1790 \begin_layout Description
1794 \begin_layout Subsection*
1797 \begin_layout Description
1798 Action Toggles Sans Serif family font (selection-wise).
1800 \begin_layout Description
1804 \begin_layout Subsection*
1807 \begin_layout Description
1808 Action Toggles Fraktur family font (math-mode, selection-wise).
1810 \begin_layout Description
1813 \begin_layout Description
1814 Origin vermeer, 10 Jan 2002
1817 \begin_layout Subsection*
1820 \begin_layout Description
1821 Action Toggles Italics font shape (math-mode, selection-wise).
1823 \begin_layout Description
1826 \begin_layout Description
1827 Origin vermeer, 10 Jan 2002
1830 \begin_layout Subsection*
1833 \begin_layout Description
1834 Action Reverts the settings of the font to the default values (selection-wise).
1836 \begin_layout Description
1840 \begin_layout Subsection*
1843 \begin_layout Description
1844 Action Sets font size according to lyx format string.
1846 \begin_layout Description
1847 Syntax font-size <SIZE>
1849 \begin_layout Description
1850 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1851 \begin_inset Newline newline
1854 largest|huge|giant|increase|decrease|default
1857 \begin_layout Subsection*
1858 LFUN_TEXTSTYLE_APPLY
1860 \begin_layout Description
1861 Action Toggle user-defined (=last-time used) text style.
1863 \begin_layout Description
1864 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1866 \begin_layout Description
1867 Syntax textstyle-apply
1869 \begin_layout Description
1870 Origin leeming, 12 Mar 2003
1873 \begin_layout Subsection*
1874 LFUN_TEXTSTYLE_UPDATE
1876 \begin_layout Description
1877 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1879 \begin_layout Description
1880 Syntax textstyle-update <FONT_INFO>
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
1887 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1889 \begin_layout Description
1890 Origin leeming, 12 Mar 2003
1893 \begin_layout Subsection*
1894 LFUN_SCREEN_FONT_UPDATE
1896 \begin_layout Description
1897 Action Update fonts and its metrics.
1899 \begin_layout Description
1900 Notion Automatically called after zoom, dpi, font names, or norm change.
1902 \begin_layout Description
1903 Syntax screen-font-update
1905 \begin_layout Description
1906 Origin ARRae, 13 Aug 2000
1909 \begin_layout Subsection*
1912 \begin_layout Description
1913 Action Returns the info about the current font.
1915 \begin_layout Description
1919 \begin_layout Subsection*
1920 LFUN_CITATION_INSERT
1922 \begin_layout Description
1923 Action Inserts citation from loaded citation database.
1925 \begin_layout Description
1926 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1928 \begin_layout Description
1929 Params <KEY>: Citation (shortcut listed in available citations).
1930 \begin_inset Newline newline
1933 <TEXT_BEFORE>: text which should appear before citation.
1935 \begin_layout Description
1936 Origin AAS, 97-02-23
1939 \begin_layout Subsection*
1940 LFUN_BIBTEX_DATABASE_ADD
1942 \begin_layout Description
1943 Action Adds database, which will be used for bibtex citations.
1945 \begin_layout Description
1946 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1948 \begin_layout Description
1949 Syntax bibtex-database-add <DATABASE-NAME>
1951 \begin_layout Description
1952 Origin Ale, 30 May 1997
1955 \begin_layout Subsection*
1956 LFUN_BIBTEX_DATABASE_DEL
1958 \begin_layout Description
1959 Action Adds database, which will be used for bibtex citations.
1961 \begin_layout Description
1962 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1964 \begin_layout Description
1965 Syntax bibtex-database-del <DATABASE-NAME>
1967 \begin_layout Description
1968 Origin Ale, 30 May 1997
1971 \begin_layout Subsection*
1974 \begin_layout Description
1975 Action Sets the layout (that is, environment) for the current paragraph.
1977 \begin_layout Description
1978 Syntax layout <LAYOUT>
1980 \begin_layout Description
1981 Params <LAYOUT>: the layout to use
1984 \begin_layout Subsection*
1985 LFUN_LAYOUT_PARAGRAPH
1987 \begin_layout Description
1988 Action Launches the paragraph settings dialog.
1990 \begin_layout Description
1991 Syntax layout-paragraph
1994 \begin_layout Subsection*
1997 \begin_layout Description
1998 Action Launches the tabular settings dialog.
2000 \begin_layout Description
2001 Syntax layout-tabular
2003 \begin_layout Description
2004 Origin Jug, 31 Jul 2000
2007 \begin_layout Subsection*
2008 LFUN_DROP_LAYOUTS_CHOICE
2010 \begin_layout Description
2011 Action Displays list of layout choices.
2013 \begin_layout Description
2014 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2016 \begin_layout Description
2017 Syntax drop-layouts-choice
2020 \begin_layout Subsection*
2021 LFUN_LAYOUT_MODULES_CLEAR
2023 \begin_layout Description
2024 Action Clears the module list.
2026 \begin_layout Description
2027 Notion Clears the list of included modules for the current buffer.
2029 \begin_layout Description
2030 Syntax layout-modules-clear
2032 \begin_layout Description
2033 Origin rgh, 25 August 2007
2036 \begin_layout Subsection*
2037 LFUN_LAYOUT_MODULE_ADD
2039 \begin_layout Description
2040 Action Adds a module.
2042 \begin_layout Description
2043 Notion Adds a module to the list of included modules for the current buffer.
2045 \begin_layout Description
2046 Syntax layout-module-add <MODULE>
2048 \begin_layout Description
2049 Params <MODULE>: the module to be added
2051 \begin_layout Description
2052 Origin rgh, 25 August 2007
2055 \begin_layout Subsection*
2058 \begin_layout Description
2059 Action Reloads layout information.
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.
2064 \begin_layout Description
2065 Syntax layout-reload
2067 \begin_layout Description
2068 Origin rgh, 3 September 2007
2071 \begin_layout Subsection*
2072 LFUN_TEXTCLASS_APPLY
2074 \begin_layout Description
2075 Action Sets the text class for the current buffer.
2077 \begin_layout Description
2078 Syntax textclass-apply <TEXTCLASS>
2080 \begin_layout Description
2081 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2084 \begin_layout Subsection*
2087 \begin_layout Description
2088 Action Loads information for a textclass from disk.
2090 \begin_layout Description
2091 Syntax textclass-load <TEXTCLASS>
2093 \begin_layout Description
2094 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2097 \begin_layout Subsection*
2100 \begin_layout Description
2101 Action Disable selecting of text-region.
2103 \begin_layout Description
2107 \begin_layout Subsection*
2110 \begin_layout Description
2111 Action Enable selecting of text-region.
2113 \begin_layout Description
2114 Notion After enabling you can simply move arrow keys to get selected region.
2116 \begin_layout Description
2120 \begin_layout Subsection*
2123 \begin_layout Description
2124 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2126 \begin_layout Description
2129 \begin_layout Description
2130 Origin Andre, May 5 2006
2133 \begin_layout Subsection*
2136 \begin_layout Description
2137 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2139 \begin_layout Description
2140 Syntax math-delim [<LEFT>] [<RIGHT>]
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.
2145 \begin_layout Description
2146 Sample math-delim { rangle
2148 \begin_layout Description
2149 Origin Alejandro, 18 Jun 1996
2152 \begin_layout Subsection*
2155 \begin_layout Description
2156 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2158 \begin_layout Description
2159 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2161 \begin_layout Description
2162 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2163 \begin_inset Newline newline
2166 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2168 \begin_layout Description
2169 Sample math-bigdelim "Bigl" "
2175 \begin_layout Description
2176 Origin Enrico & Georg, 7 May 2006
2179 \begin_layout Subsection*
2182 \begin_layout Description
2183 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2185 \begin_layout Description
2186 Syntax math-display [<ARG>]
2188 \begin_layout Description
2189 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2191 \begin_layout Description
2192 Origin Alejandro, 18 Jun 1996
2195 \begin_layout Subsection*
2198 \begin_layout Description
2199 Action Inserts math objects and symbols.
2201 \begin_layout Description
2202 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
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
2206 frac{x}{y}" replaces "abc" with "
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.
2210 \begin_layout Description
2211 Syntax math-insert <ARG>
2213 \begin_layout Description
2214 Params <ARG>: Symbol or LaTeX code to be inserted.
2217 \begin_layout Subsection*
2220 \begin_layout Description
2221 Action Enters subscript expression in math expression.
2223 \begin_layout Description
2224 Syntax math-subscript
2226 \begin_layout Description
2227 Origin vermeer, 12 Dec 2001
2230 \begin_layout Subsection*
2231 LFUN_MATH_SUPERSCRIPT
2233 \begin_layout Description
2234 Action Enters subscript expression in math expression.
2236 \begin_layout Description
2237 Syntax math-superscript
2239 \begin_layout Description
2240 Origin vermeer, 12 Dec 2001
2243 \begin_layout Subsection*
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.
2249 \begin_layout Description
2250 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2252 \begin_layout Description
2253 Syntax math-limits [<STATE>]
2255 \begin_layout Description
2256 Params <STATE>: limits|nolimits
2259 \begin_layout Subsection*
2262 \begin_layout Description
2263 Action Inserts a math macro definition at the cursor position in the text.
2265 \begin_layout Description
2266 Syntax math-macro <NAME> [<NARGS>] [def]
2268 \begin_layout Description
2269 Params <NAME>: The name of the macro, e.g. "mymacro".
2270 \begin_inset Newline newline
2273 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2275 \begin_layout Description
2276 Origin ale, 10 May 1997; sts, 21 Dec 2007
2279 \begin_layout Subsection*
2282 \begin_layout Description
2283 Action Mutates the type of math inset to the newly selected one.
2285 \begin_layout Description
2286 Syntax math-mutate <TYPE>
2288 \begin_layout Description
2289 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2291 \begin_layout Description
2292 Origin Andre, 23 May 2001
2295 \begin_layout Subsection*
2298 \begin_layout Description
2299 Action Inserts space into math expression.
2301 \begin_layout Description
2302 Notion Use spacebar after entering this space to change type of space.
2304 \begin_layout Description
2305 Syntax math-space [<TYPE>] [<LEN>]
2307 \begin_layout Description
2308 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2309 \begin_inset Newline newline
2312 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2313 \begin_inset Newline newline
2316 custom space: hspace
2317 \begin_inset Newline newline
2320 "," used by default.
2321 \begin_inset Newline newline
2324 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2325 \begin_inset Newline newline
2328 <LEN>: length for custom spaces (hspace)
2330 \begin_layout Description
2331 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2334 \begin_layout Subsection*
2337 \begin_layout Description
2338 Action Inserts a matrix.
2340 \begin_layout Description
2341 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
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).
2346 \begin_layout Description
2347 Sample math-matrix 3 3 bccc
2350 \begin_layout Subsection*
2351 LFUN_MATH_AMS_MATRIX
2353 \begin_layout Description
2354 Action Inserts a matrix.
2356 \begin_layout Description
2357 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2359 \begin_layout Description
2360 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2362 \begin_layout Description
2363 Sample math-ams-matrix 3 3 bmatrix
2366 \begin_layout Subsection*
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.
2372 \begin_layout Description
2373 Notion If there is some selected text, it puts the text inside created math box.
2375 \begin_layout Description
2376 Syntax math-mode [on|<ARG>]
2378 \begin_layout Description
2379 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2380 \begin_inset Newline newline
2383 "on": allow only entering of math mode from text mode.
2385 \begin_layout Description
2386 Origin Alejandro, 4 Jun 1996
2389 \begin_layout Subsection*
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.
2395 \begin_layout Description
2396 Notion If there is any selected text, then it is moved inside the created regexp inset.
2398 \begin_layout Description
2399 Syntax regexp-mode [<ARG>]
2401 \begin_layout Description
2402 Params <ARG>: eventual argument (regular expression).
2404 \begin_layout Description
2405 Origin Tommaso, 4 Oct 2008
2408 \begin_layout Subsection*
2409 LFUN_MATH_NUMBER_LINE_TOGGLE
2411 \begin_layout Description
2412 Action Toggles numbering of the current formula line.
2414 \begin_layout Description
2415 Notion Must be in display formula mode.
2417 \begin_layout Description
2418 Syntax math-number-line-toggle
2420 \begin_layout Description
2421 Origin Alejandro, 18 Jun 1996
2424 \begin_layout Subsection*
2425 LFUN_MATH_NUMBER_TOGGLE
2427 \begin_layout Description
2428 Action Toggles numbering/labeling of the current formula.
2430 \begin_layout Description
2431 Notion Must be in display formula mode.
2433 \begin_layout Description
2434 Syntax math-number-toggle
2436 \begin_layout Description
2437 Origin Alejandro, 4 Jun 1996
2440 \begin_layout Subsection*
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.
2446 \begin_layout Description
2447 Notion Selection can be used to determine the input for the external program.
2449 \begin_layout Description
2450 Syntax math-extern <LANG> [<COMMAND>]
2452 \begin_layout Description
2453 Params <LANG>: octave|maxima|maple|mathematica|script
2454 \begin_inset Newline newline
2457 where "script" stands fot the external script (normalized expression will be passed)
2459 \begin_layout Description
2460 Sample math-extern maple simplify
2462 \begin_layout Description
2463 Origin Andre, 24 Apr 2001
2466 \begin_layout Subsection*
2469 \begin_layout Description
2470 Action Changes arbitrarily the size used by math fonts inside a context.
2472 \begin_layout Description
2473 Notion Provides an interface to the LaTeX math mode font size commands.
2475 \begin_layout Description
2476 Syntax math-size <STYLE>
2478 \begin_layout Description
2489 \begin_layout Description
2490 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2493 \begin_layout Subsection*
2494 LFUN_MATH_FONT_STYLE
2496 \begin_layout Description
2497 Action Changes the text style used in math.
2499 \begin_layout Description
2500 Syntax math-font-style <STYLE>
2502 \begin_layout Description
2503 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2505 \begin_layout Description
2506 Origin vfr, 9 jan 2009
2509 \begin_layout Subsection*
2510 LFUN_MATH_MACRO_UNFOLD
2512 \begin_layout Description
2513 Action Unfold a Math Macro.
2515 \begin_layout Description
2516 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2520 \begin_layout Description
2521 Syntax math-macro-unfold
2523 \begin_layout Description
2524 Origin sts, 06 January 2008
2527 \begin_layout Subsection*
2528 LFUN_MATH_MACRO_FOLD
2530 \begin_layout Description
2531 Action Fold a Math Macro.
2533 \begin_layout Description
2534 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2538 \begin_layout Description
2539 Syntax math-macro-fold
2541 \begin_layout Description
2542 Origin sts, 06 January 2008
2545 \begin_layout Subsection*
2546 LFUN_MATH_MACRO_ADD_PARAM
2548 \begin_layout Description
2549 Action Add a parameter.
2551 \begin_layout Description
2552 Notion Add a parameter to a Math Macro.
2554 \begin_layout Description
2555 Syntax math-macro-add-param <NUM>
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.
2560 \begin_layout Description
2561 Origin sts, 06 January 2008
2564 \begin_layout Subsection*
2565 LFUN_MATH_MACRO_REMOVE_PARAM
2567 \begin_layout Description
2568 Action Remove the last parameter.
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.
2573 \begin_layout Description
2574 Syntax math-macro-remove-param <NUM>
2576 \begin_layout Description
2577 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2579 \begin_layout Description
2580 Origin sts, 06 January 2008
2583 \begin_layout Subsection*
2584 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2586 \begin_layout Description
2587 Action Append a greedy parameter.
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.
2592 \begin_layout Description
2593 Syntax math-macro-append-greedy-param
2595 \begin_layout Description
2596 Origin sts, 06 January 2008
2599 \begin_layout Subsection*
2600 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2602 \begin_layout Description
2603 Action Remove a greedy parameter.
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.
2608 \begin_layout Description
2609 Syntax math-macro-remove-greedy-param
2611 \begin_layout Description
2612 Origin sts, 06 January 2008
2615 \begin_layout Subsection*
2616 LFUN_MATH_MACRO_MAKE_OPTIONAL
2618 \begin_layout Description
2619 Action Make a parameter optional.
2621 \begin_layout Description
2622 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2624 \begin_layout Description
2625 Syntax math-macro-make-optional
2627 \begin_layout Description
2628 Origin sts, 06 January 2008
2631 \begin_layout Subsection*
2632 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2634 \begin_layout Description
2635 Action Make a parameter non-optional.
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.
2640 \begin_layout Description
2641 Syntax math-macro-make-nonoptional
2643 \begin_layout Description
2644 Origin sts, 06 January 2008
2647 \begin_layout Subsection*
2648 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2650 \begin_layout Description
2651 Action Add an optional parameter.
2653 \begin_layout Description
2654 Notion Insert an optional parameter just behind the already existing optional parameters.
2656 \begin_layout Description
2657 Syntax math-macro-add-optional-param
2659 \begin_layout Description
2660 Origin sts, 06 January 2008
2663 \begin_layout Subsection*
2664 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2666 \begin_layout Description
2667 Action Remove the last optional parameter.
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.
2672 \begin_layout Description
2673 Syntax math-macro-remove-optional-param
2675 \begin_layout Description
2676 Origin sts, 06 January 2008
2679 \begin_layout Subsection*
2680 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2682 \begin_layout Description
2683 Action Add a greedy optional parameter.
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.
2688 \begin_layout Description
2689 Syntax math-macro-add-greedy-optional-param
2691 \begin_layout Description
2692 Origin sts, 06 January 2008
2695 \begin_layout Subsection*
2696 LFUN_IN_MATHMACROTEMPLATE
2698 \begin_layout Description
2699 Action Only active in Math Macro definition.
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.
2704 \begin_layout Description
2705 Syntax in-mathmacrotemplate
2707 \begin_layout Description
2708 Origin sts, 06 January 2008
2711 \begin_layout Subsection*
2712 LFUN_PARAGRAPH_MOVE_DOWN
2714 \begin_layout Description
2715 Action Moves the current paragraph downwards in the document.
2717 \begin_layout Description
2718 Syntax paragraph-move-down
2720 \begin_layout Description
2721 Origin Edwin, 8 Apr 2006
2724 \begin_layout Subsection*
2725 LFUN_PARAGRAPH_MOVE_UP
2727 \begin_layout Description
2728 Action Moves the current paragraph upwards in the document.
2730 \begin_layout Description
2731 Syntax paragraph-move-up
2733 \begin_layout Description
2734 Origin Edwin, 8 Apr 2006
2737 \begin_layout Subsection*
2740 \begin_layout Description
2741 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2743 \begin_layout Description
2746 \begin_layout Description
2747 Origin Asger, 1 Oct 1996
2750 \begin_layout Subsection*
2751 LFUN_PARAGRAPH_UP_SELECT
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.
2756 \begin_layout Description
2757 Syntax paragraph-up-select
2759 \begin_layout Description
2760 Origin Asger, 1 Oct 1996
2763 \begin_layout Subsection*
2766 \begin_layout Description
2767 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2769 \begin_layout Description
2770 Syntax paragraph-down
2772 \begin_layout Description
2773 Origin Asger, 1 Oct 1996
2776 \begin_layout Subsection*
2777 LFUN_PARAGRAPH_DOWN_SELECT
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.
2782 \begin_layout Description
2783 Syntax paragraph-down-select
2785 \begin_layout Description
2786 Origin Asger, 1 Oct 1996
2789 \begin_layout Subsection*
2792 \begin_layout Description
2793 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
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).
2798 \begin_layout Description
2799 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2801 \begin_layout Description
2802 Params <PAR_ID_NUMBER>: paragraph id
2803 \begin_inset Newline newline
2806 <POSITION_IN_PAR>: desired position within the paragraph
2808 \begin_layout Description
2809 Origin Dekel, 26 Aug 2000
2812 \begin_layout Subsection*
2813 LFUN_BREAK_PARAGRAPH
2815 \begin_layout Description
2816 Action Breaks the current paragraph at the current location.
2818 \begin_layout Description
2819 Notion Removes the selection.
2821 \begin_layout Description
2822 Syntax break-paragraph [<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.
2828 \begin_layout Subsection*
2829 LFUN_PARAGRAPH_PARAMS
2831 \begin_layout Description
2832 Action Change paragraph settings.
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.
2837 \begin_layout Description
2838 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2840 \begin_layout Description
2850 \begin_inset Newline newline
2855 paragraph_spacing default|single|onehalf|double|other SIZE
2856 \begin_inset Newline newline
2861 align block|left|right|center|default
2862 \begin_inset Newline newline
2867 labelwidthstring WIDTH|
2871 \begin_layout Description
2872 Origin rgh, Aug 15 2007
2875 \begin_layout Subsection*
2876 LFUN_PARAGRAPH_PARAMS_APPLY
2878 \begin_layout Description
2879 Action Change paragraph settings.
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.
2884 \begin_layout Description
2885 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2887 \begin_layout Description
2888 Params For parameters see LFUN_PARAGRAPH_PARAMS
2890 \begin_layout Description
2891 Origin leeming, 30 Mar 2004
2894 \begin_layout Subsection*
2895 LFUN_PARAGRAPH_UPDATE
2897 \begin_layout Description
2898 Action Updates the values inside the paragraph dialog from the paragraph.
2900 \begin_layout Description
2901 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2903 \begin_layout Description
2904 Origin leeming, 13 Mar 2003
2907 \begin_layout Subsection*
2910 \begin_layout Description
2911 Action Move the current group in the upward direction in the structure of the document.
2913 \begin_layout Description
2914 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2916 \begin_layout Description
2919 \begin_layout Description
2920 Origin Vermeer, 23 Mar 2006
2923 \begin_layout Subsection*
2926 \begin_layout Description
2927 Action Move the current group in the downward direction in the structure of the document.
2929 \begin_layout Description
2930 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2932 \begin_layout Description
2935 \begin_layout Description
2936 Origin Vermeer, 23 Mar 2006
2939 \begin_layout Subsection*
2942 \begin_layout Description
2943 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2945 \begin_layout Description
2946 Notion Part -> Chapter -> Section -> etc.
2948 \begin_layout Description
2951 \begin_layout Description
2952 Origin Vermeer, 23 Mar 2006
2955 \begin_layout Subsection*
2958 \begin_layout Description
2959 Action Moves the current group in the upward direction in the hierarchy of the document structure.
2961 \begin_layout Description
2962 Notion Part <- Chapter <- Section <- etc.
2964 \begin_layout Description
2967 \begin_layout Description
2968 Origin Vermeer, 23 Mar 2006
2971 \begin_layout Subsection*
2972 LFUN_OUTLINE_DRAGMOVE
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.
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).
2980 \begin_layout Description
2981 Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
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
2988 <PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved to.
2990 \begin_layout Description
2991 Origin Rob Oakes, 22 June 2009
2994 \begin_layout Subsection*
2997 \begin_layout Description
2998 Action Edit the inset at cursor with an external application, if one is attributed.
3000 \begin_layout Description
3001 Syntax inset-edit [<INSET_PARAMS>]
3003 \begin_layout Description
3004 Params <INSET_PARAMS>: Parameters for the inset.
3005 \begin_inset Newline newline
3008 Currently only the filename will be considered.
3010 \begin_layout Description
3011 Origin JSpitzm, 27 Apr 2006
3014 \begin_layout Subsection*
3017 \begin_layout Description
3018 Action Inserts table into the document.
3020 \begin_layout Description
3021 Syntax tabular-insert [<ROWS> <COLUMNS>]
3023 \begin_layout Description
3024 Params In case no arguments are given show insert dialog.
3026 \begin_layout Description
3027 Origin Jug, 12 Apr 2000
3030 \begin_layout Subsection*
3031 LFUN_TABULAR_FEATURE
3033 \begin_layout Description
3034 Action Sets various features to the table/cell on the current cursor position.
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
3039 \begin_layout Description
3040 Syntax tabular-feature <FEATURE> [<ARG>]
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
3047 <ARG>: additional argument for some commands, use debug mode to explore its values.
3049 \begin_layout Description
3050 Origin Jug, 28 Jul 2000
3053 \begin_layout Subsection*
3056 \begin_layout Description
3057 Action Moves the cursor to the previous cell inside the table.
3059 \begin_layout Description
3060 Syntax cell-backward
3062 \begin_layout Description
3063 Origin Jug, 22 May 2000
3066 \begin_layout Subsection*
3069 \begin_layout Description
3070 Action Moves the cursor to the next cell inside the table.
3072 \begin_layout Description
3076 \begin_layout Subsection*
3079 \begin_layout Description
3080 Action Splits cell and shifts right part to the next cell (inside the math grid).
3082 \begin_layout Description
3085 \begin_layout Description
3086 Origin Ale, 15 May 1997
3089 \begin_layout Subsection*
3092 \begin_layout Description
3093 Action Register the document as an file inside version control system (RCS, CVS).
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
3100 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3102 \begin_layout Description
3105 \begin_layout Description
3106 Origin Lgb, 1 Jul 1997
3109 \begin_layout Subsection*
3112 \begin_layout Description
3113 Action Checks-in/commits the changes of the registered file to the repository.
3115 \begin_layout Description
3116 Notion In RCS case this also unlocks the file.
3118 \begin_layout Description
3121 \begin_layout Description
3122 Origin Lgb, 1 Jul 1997
3125 \begin_layout Subsection*
3128 \begin_layout Description
3129 Action Checks-out the document for edit (and locks it for RCS).
3131 \begin_layout Description
3132 Notion This is implemented only for RCS and SVN, not CVS.
3134 \begin_layout Description
3137 \begin_layout Description
3138 Origin Lgb, 1 Jul 1997
3141 \begin_layout Subsection*
3144 \begin_layout Description
3145 Action Reverts the document to the last check-in/commit in VCS.
3147 \begin_layout Description
3150 \begin_layout Description
3151 Origin Lgb, 1 Jul 1997
3154 \begin_layout Subsection*
3157 \begin_layout Description
3158 Action Undo last check-in.
3160 \begin_layout Description
3161 Notion This is currently implemented only for RCS.
3163 \begin_layout Description
3166 \begin_layout Description
3167 Origin Lgb, 1 Jul 1997
3170 \begin_layout Subsection*
3173 \begin_layout Description
3174 Action Executes external command. This command is intended to support additional VCS commands.
3176 \begin_layout Description
3177 Syntax vc-command <FLAG> <PATH> <COMMAND>
3179 \begin_layout Description
3180 Params <FLAG>: Flags for the command can be combined together.
3181 \begin_inset Newline newline
3184 U - dUmmy - no flags
3185 \begin_inset Newline newline
3188 D - Doc - need document loaded to proceed
3189 \begin_inset Newline newline
3192 I - dIrty - mark document dirty
3193 \begin_inset Newline newline
3196 R - Reload - ensure that the document is saved and reload it after command execution
3197 \begin_inset Newline newline
3200 M - Message - ask for input string (commit message)
3201 \begin_inset Newline newline
3204 <PATH>: path where to start. $$p will be replaced by the current document path.
3205 \begin_inset Newline newline
3208 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
3210 \begin_layout Description
3211 Sample vc-command DR $$p "svn up"
3213 \begin_layout Description
3214 Origin sanda, 13 Jan 2009
3217 \begin_layout Subsection*
3218 LFUN_VC_LOCKING_TOGGLE
3220 \begin_layout Description
3221 Action Toggles the locking property of the edited file.
3223 \begin_layout Description
3224 Notion This is currently implemented only for SVN.
3226 \begin_layout Description
3227 Syntax vc-locking-toggle
3229 \begin_layout Description
3230 Origin sanda, 25 Jun 2009
3233 \begin_layout Subsection*
3236 \begin_layout Description
3237 Action Toggles change tracking to on/off.
3239 \begin_layout Description
3240 Syntax changes-track
3242 \begin_layout Description
3243 Origin levon, 1 Oct 2002
3246 \begin_layout Subsection*
3249 \begin_layout Description
3250 Action Toggles showing of change tracking in typesetted output.
3252 \begin_layout Description
3253 Syntax changes-output
3255 \begin_layout Description
3256 Origin jspitzm, 21 Jan 2005
3259 \begin_layout Subsection*
3262 \begin_layout Description
3263 Action Moves the cursor to the position of the next change of the change tracking records.
3265 \begin_layout Description
3268 \begin_layout Description
3269 Origin schmitt, 4 Oct 2006
3272 \begin_layout Subsection*
3273 LFUN_CHANGE_PREVIOUS
3275 \begin_layout Description
3276 Action Moves the cursor to the position of the previous change of the change tracking records.
3278 \begin_layout Description
3279 Syntax change-previous
3281 \begin_layout Description
3282 Origin vfr, 4 Apr 2009
3285 \begin_layout Subsection*
3288 \begin_layout Description
3289 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3291 \begin_layout Description
3292 Syntax changes-merge
3294 \begin_layout Description
3295 Origin Levon, 16 Oct 2002
3298 \begin_layout Subsection*
3301 \begin_layout Description
3302 Action Accepts tracked change inside the selection.
3304 \begin_layout Description
3305 Syntax change-accept
3307 \begin_layout Description
3308 Origin Levon, 16 Oct 2002
3311 \begin_layout Subsection*
3314 \begin_layout Description
3315 Action Rejects tracked change inside the selection.
3317 \begin_layout Description
3318 Syntax change-accept
3320 \begin_layout Description
3321 Origin Levon, 16 Oct 2002
3324 \begin_layout Subsection*
3325 LFUN_ALL_CHANGES_ACCEPT
3327 \begin_layout Description
3328 Action Accepts all tracked changes in the document.
3330 \begin_layout Description
3331 Syntax all-changes-accept
3333 \begin_layout Description
3334 Origin Levon, 16 Oct 2002
3337 \begin_layout Subsection*
3338 LFUN_ALL_CHANGES_REJECT
3340 \begin_layout Description
3341 Action Rejects all tracked changes in the document.
3343 \begin_layout Description
3344 Notion Reject does not work recursively; the user may have to repeat the operation.
3346 \begin_layout Description
3347 Syntax all-changes-reject
3349 \begin_layout Description
3350 Origin Levon, 16 Oct 2002
3353 \begin_layout Subsection*
3356 \begin_layout Description
3357 Action Apply data for an inset.
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.
3362 \begin_layout Description
3363 Syntax inset-apply <ARGS>
3365 \begin_layout Description
3366 Params See LFUN_INSET_INSERT .
3369 \begin_layout Subsection*
3372 \begin_layout Description
3373 Action Dissolve the current inset into text.
3375 \begin_layout Description
3376 Syntax inset-dissolve [<INSET>]
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
3383 For values see lyx::InsetLayout::lyxtype_ .
3385 \begin_layout Description
3386 Origin JSpitz, 7 Aug 2006
3389 \begin_layout Subsection*
3392 \begin_layout Description
3393 Action Insert new inset (type given by the parameters).
3395 \begin_layout Description
3396 Syntax inset-insert <INSET> <ARGS>
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
3403 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3405 \begin_layout Description
3406 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3409 \begin_inset Newline newline
3412 where <label name> is the name of the referenced label and <Format> is one of the following:
3413 \begin_inset Newline newline
3417 \begin_inset Newline newline
3420 eqref -- (<reference>)
3421 \begin_inset Newline newline
3425 \begin_inset Newline newline
3428 vpageref -- on <page>
3429 \begin_inset Newline newline
3432 vref -- <reference> on <page>
3433 \begin_inset Newline newline
3436 prettyref -- Formatted reference
3439 \begin_layout Subsection*
3442 \begin_layout Description
3443 Action Modify existing inset.
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.
3448 \begin_layout Description
3449 Syntax inset-modify <INSET> <ARGS>
3451 \begin_layout Description
3452 Params See LFUN_INSET_INSERT for further details.
3455 \begin_layout Subsection*
3456 LFUN_NEXT_INSET_MODIFY
3458 \begin_layout Description
3459 Action Modify the inset at cursor position, if there is one.
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.
3464 \begin_layout Description
3465 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
3467 \begin_layout Description
3468 Params See LFUN_INSET_INSERT for further details.
3470 \begin_layout Description
3471 Origin JSpitzm, 23 Mar 2008
3474 \begin_layout Subsection*
3475 LFUN_INSET_DIALOG_UPDATE
3477 \begin_layout Description
3478 Action Updates the values inside the dialog from the inset.
3480 \begin_layout Description
3481 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3483 \begin_layout Description
3484 Params <DIALOG-NAME>
3486 \begin_layout Description
3487 Origin leeming, 25 Feb 2003
3490 \begin_layout Subsection*
3493 \begin_layout Description
3494 Action Open the inset's properties dialog.
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.
3499 \begin_layout Description
3500 Syntax inset-settings <INSET>
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>.
3506 \begin_layout Subsection*
3509 \begin_layout Description
3510 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3512 \begin_layout Description
3513 Syntax inset-toggle [<ARG>]
3515 \begin_layout Description
3516 Params <ARG>: <open|close|toggle|assign>.
3517 \begin_inset Newline newline
3520 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3521 \begin_inset Newline newline
3524 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3526 \begin_layout Description
3527 Origin lasgouttes, 19 Jul 2001
3530 \begin_layout Subsection*
3531 LFUN_ALL_INSETS_TOGGLE
3533 \begin_layout Description
3534 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3536 \begin_layout Description
3537 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3539 \begin_layout Description
3540 Syntax all-insets-toggle [<STATE>] [<INSET>]
3542 \begin_layout Description
3543 Params <STATE>: <toggle|open|close|assign> default: toggle
3544 \begin_inset Newline newline
3547 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3549 \begin_layout Description
3550 Origin leeming, 30 Mar 2004
3553 \begin_layout Subsection*
3554 LFUN_SET_GRAPHICS_GROUP
3556 \begin_layout Description
3557 Action Set the group for the graphics inset on the cursor position.
3559 \begin_layout Description
3560 Syntax set-graphics-group [<GROUP>]
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.
3565 \begin_layout Description
3566 Origin sanda, 6 May 2008
3569 \begin_layout Subsection*
3570 LFUN_FINISHED_FORWARD
3572 \begin_layout Description
3573 Action Moves the cursor out of the current slice, going forward.
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.
3579 \begin_layout Subsection*
3580 LFUN_FINISHED_BACKWARD
3582 \begin_layout Description
3583 Action Moves the cursor out of the current slice, going backwards.
3585 \begin_layout Description
3586 Notion See also LFUN_FINISHED_FORWARD.
3589 \begin_layout Subsection*
3592 \begin_layout Description
3593 Action Moves the cursor out of the current slice, going right.
3595 \begin_layout Description
3596 Notion See also LFUN_FINISHED_FORWARD
3599 \begin_layout Subsection*
3602 \begin_layout Description
3603 Action Moves the cursor out of the current slice, going left.
3605 \begin_layout Description
3606 Notion See also LFUN_FINISHED_FORWARD.
3609 \begin_layout Subsection*
3612 \begin_layout Description
3613 Action Set language from the current cursor position.
3615 \begin_layout Description
3616 Syntax language <LANG>
3618 \begin_layout Description
3619 Params <LANG>: Requested language. Look in lib/languages for the list.
3621 \begin_layout Description
3622 Origin Dekel, 2 Mar 2000
3625 \begin_layout Subsection*
3628 \begin_layout Description
3629 Action Goto a label.
3631 \begin_layout Description
3632 Syntax label-goto [<LABEL>]
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.
3637 \begin_layout Description
3638 Origin Ale, 6 Aug 1997
3641 \begin_layout Subsection*
3644 \begin_layout Description
3645 Action Inserts label to text or displayed formula.
3647 \begin_layout Description
3648 Syntax label-insert [<LABEL>]
3650 \begin_layout Description
3651 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3654 \begin_layout Subsection*
3657 \begin_layout Description
3658 Action Go to the next label or cross-reference.
3660 \begin_layout Description
3661 Syntax reference-next
3663 \begin_layout Description
3664 Origin Dekel, 14 Jan 2001
3667 \begin_layout Subsection*
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.
3673 \begin_layout Description
3674 Notion Bookmark 0 has a special purpose. It is automatically set
3675 \begin_inset Newline newline
3678 1. to the paragraph you are currently editing
3679 \begin_inset Newline newline
3682 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3683 \begin_inset Newline newline
3686 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3688 \begin_layout Description
3689 Syntax bookmark-goto <NUMBER>
3691 \begin_layout Description
3692 Params <NUMBER>: the number of the bookmark to restore.
3694 \begin_layout Description
3695 Origin Dekel, 27 January 2001
3698 \begin_layout Subsection*
3701 \begin_layout Description
3702 Action Save a bookmark.
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.
3707 \begin_layout Description
3708 Syntax bookmark-save <NUMBER>
3710 \begin_layout Description
3711 Params <NUMBER>: the number of the bookmark to save.
3713 \begin_layout Description
3714 Origin Dekel, 27 January 2001
3717 \begin_layout Subsection*
3720 \begin_layout Description
3721 Action Clears the list of saved bookmarks.
3723 \begin_layout Description
3724 Syntax bookmark-clear
3726 \begin_layout Description
3727 Origin bpeng, 31 October 2006
3730 \begin_layout Subsection*
3733 \begin_layout Description
3734 Action Open the given help file according to the language setting.
3736 \begin_layout Description
3737 Syntax help-open <FILE>[.lyx]
3739 \begin_layout Description
3740 Params <FILE>: any document from (/usr/share/)doc directory.
3742 \begin_layout Description
3743 Origin Jug, 27 Jun 1999
3746 \begin_layout Subsection*
3749 \begin_layout Description
3750 Action Terminates the current LyX instance.
3752 \begin_layout Description
3753 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3755 \begin_layout Description
3759 \begin_layout Subsection*
3762 \begin_layout Description
3763 Action Toggles visibility of a given toolbar between on/off/auto.
3765 \begin_layout Description
3766 Notion Skiping "auto" when allowauto is false.
3768 \begin_layout Description
3769 Syntax toolbar-toggle <NAME> [allowauto]
3771 \begin_layout Description
3772 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3774 \begin_layout Description
3775 Origin Edwin, 21 May 2007
3778 \begin_layout Subsection*
3781 \begin_layout Description
3782 Action Opens the menu given by its name.
3784 \begin_layout Description
3785 Syntax menu-open <NAME>
3787 \begin_layout Description
3788 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3791 \begin_layout Subsection*
3794 \begin_layout Description
3795 Action Various UI visibility-toggling actions.
3797 \begin_layout Description
3798 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3800 \begin_layout Description
3801 Params statusbar : Toggle visibility of the statusbar.
3802 \begin_inset Newline newline
3805 menubar : Toggle visibility of the menubar.
3806 \begin_inset Newline newline
3809 scrollbar : Toggle visibility of the scrollbar.
3810 \begin_inset Newline newline
3813 frame : Toggle visibility of the frames around editing window.
3814 \begin_inset Newline newline
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.
3819 \begin_layout Description
3820 Origin sanda, 9 Feb 2007
3823 \begin_layout Subsection*
3826 \begin_layout Description
3827 Action Creates new empty LyX window.
3829 \begin_layout Description
3830 Notion Already opened documents from the previous window can be found under View menu.
3832 \begin_layout Description
3833 Syntax window-new [<GEOMETRY>]
3835 \begin_layout Description
3836 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3838 \begin_layout Description
3839 Origin Abdel, 21 Oct 2006
3842 \begin_layout Subsection*
3845 \begin_layout Description
3846 Action Closes the current LyX window.
3848 \begin_layout Description
3851 \begin_layout Description
3852 Origin Abdel, 23 Oct 2006
3855 \begin_layout Subsection*
3858 \begin_layout Description
3859 Action Creates another split view of current buffer.
3861 \begin_layout Description
3862 Notion All split views act in the same way indpendently.
3864 \begin_layout Description
3865 Syntax split-view <vertical|horizontal>
3867 \begin_layout Description
3868 Params horizontal : The work areas are laid out side by side.
3869 \begin_inset Newline newline
3872 vertical : The work areas laid out vertically.
3874 \begin_layout Description
3875 Origin Abdel, 20 Feb 2008
3878 \begin_layout Subsection*
3879 LFUN_CLOSE_TAB_GROUP
3881 \begin_layout Description
3882 Action Close the current tab group.
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.
3887 \begin_layout Description
3888 Syntax close-tab-group
3890 \begin_layout Description
3891 Origin Abdel, 21 Feb 2008
3894 \begin_layout Subsection*
3897 \begin_layout Description
3898 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3900 \begin_layout Description
3901 Syntax dialog-show <NAME> [<DATA>]
3903 \begin_layout Description
3904 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3905 \begin_inset Newline newline
3908 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
3909 \begin_inset Newline newline
3912 href|include|index|index_print|info|label|listings|log|mathdelimiter|
3913 \begin_inset Newline newline
3916 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
3917 \begin_inset Newline newline
3920 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
3921 \begin_inset Newline newline
3924 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
3925 \begin_inset Newline newline
3928 <SPECIAL>: latexlog|vclog
3929 \begin_inset Newline newline
3932 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
3934 \begin_layout Description
3935 Origin leeming, 17 Jun 2003
3938 \begin_layout Subsection*
3939 LFUN_DIALOG_SHOW_NEW_INSET
3941 \begin_layout Description
3942 Action Shows hidden dialog or create new one for a given inset settings etc.
3944 \begin_layout Description
3945 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
3947 \begin_layout Description
3948 Syntax dialog-show-new-inset <NAME> [<DATA>]
3950 \begin_layout Description
3951 Params See LFUN_DIALOG_SHOW .
3953 \begin_layout Description
3954 Origin leeming, 25 Feb 2003
3957 \begin_layout Subsection*
3960 \begin_layout Description
3961 Action Updates the dialog values from the inset/paragraph/document.
3963 \begin_layout Description
3964 Syntax dialog-update <NAME>
3966 \begin_layout Description
3967 Params <NAME>: paragraph|prefs|<INSET>
3968 \begin_inset Newline newline
3973 \begin_layout Description
3974 Origin leeming, 25 Feb 2003
3977 \begin_layout Subsection*
3980 \begin_layout Description
3981 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
3983 \begin_layout Description
3984 Syntax dialog-hide <NAME>
3986 \begin_layout Description
3987 Params See LFUN_DIALOG_SHOW .
3989 \begin_layout Description
3990 Origin leeming, 25 Feb 2003
3993 \begin_layout Subsection*
3996 \begin_layout Description
3997 Action Toggles dialog between showed/hidden state.
3999 \begin_layout Description
4000 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4002 \begin_layout Description
4003 Syntax dialog-toggle <NAME> [<DATA>]
4005 \begin_layout Description
4006 Params See LFUN_DIALOG_SHOW .
4008 \begin_layout Description
4009 Origin JSpitzm, 30 Apr 2007
4012 \begin_layout Subsection*
4013 LFUN_DIALOG_DISCONNECT_INSET
4015 \begin_layout Description
4016 Action Closes opened connection to opened inset.
4018 \begin_layout Description
4019 Notion Connection is used for apply functions.
4021 \begin_layout Description
4022 Syntax dialog-disconnect-inset <INSET-NAME>
4024 \begin_layout Description
4025 Origin leeming, 25 Feb 2003
4028 \begin_layout Subsection*
4031 \begin_layout Description
4032 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4034 \begin_layout Description
4035 Notion This is internal LFUN, not to be used by users.
4037 \begin_layout Description
4038 Origin Andre, 9 Aug 2002
4041 \begin_layout Subsection*
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.
4047 \begin_layout Description
4048 Notion This is internal LFUN, not to be used by users.
4050 \begin_layout Description
4051 Origin Andre, 9 Aug 2002
4054 \begin_layout Subsection*
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.
4060 \begin_layout Description
4061 Notion This is internal LFUN, not to be used by users.
4063 \begin_layout Description
4064 Origin Andre, 9 Aug 2002
4067 \begin_layout Subsection*
4070 \begin_layout Description
4071 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4073 \begin_layout Description
4074 Notion This is internal LFUN, not to be used by users.
4076 \begin_layout Description
4077 Origin Andre, 9 Aug 2002
4080 \begin_layout Subsection*
4083 \begin_layout Description
4084 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4086 \begin_layout Description
4087 Notion This is internal LFUN, not to be used by users.
4089 \begin_layout Description
4090 Origin Andre, 9 Aug 2002
4093 \begin_layout Subsection*
4096 \begin_layout Description
4097 Action Turn off the loaded keyboard map.
4099 \begin_layout Description
4103 \begin_layout Subsection*
4106 \begin_layout Description
4107 Action Turn on the primary keyboard map.
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
4114 The language is to be set in the Preferences dialog.
4116 \begin_layout Description
4117 Syntax keymap-primary
4120 \begin_layout Subsection*
4121 LFUN_KEYMAP_SECONDARY
4123 \begin_layout Description
4124 Action Turn on the secondary keyboard map.
4126 \begin_layout Description
4127 Syntax keymap-secondary
4130 \begin_layout Subsection*
4133 \begin_layout Description
4134 Action Toggles keyboard maps (first/second/off).
4136 \begin_layout Description
4137 Syntax keymap-toggle
4139 \begin_layout Description
4140 Origin leeming, 30 Mar 2004
4143 \begin_layout Subsection*
4144 LFUN_SERVER_GET_LAYOUT
4146 \begin_layout Description
4147 Action Returns the current layout (that is environment) name on the cursor position.
4149 \begin_layout Description
4150 Syntax server-get-layout
4153 \begin_layout Subsection*
4154 LFUN_SERVER_GET_FILENAME
4156 \begin_layout Description
4157 Action Returns path and file name of the currently edited document.
4159 \begin_layout Description
4160 Syntax server-get-filename
4163 \begin_layout Subsection*
4164 LFUN_SERVER_GOTO_FILE_ROW
4166 \begin_layout Description
4167 Action Sets the cursor position based on the row number of generated TeX file.
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).
4172 \begin_layout Description
4173 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
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
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.
4182 \begin_layout Description
4183 Origin Edmar, 23 Dec 1998
4186 \begin_layout Subsection*
4189 \begin_layout Description
4190 Action Sends notify message about the last key-sequence to client.
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.
4195 \begin_layout Description
4196 Syntax server-notify
4199 \begin_layout Subsection*
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).
4205 \begin_layout Description
4206 Syntax server-set-xy <X> <Y>
4209 \begin_layout Subsection*
4212 \begin_layout Description
4213 Action Returns the coordinates of cursor position in the editing area.
4215 \begin_layout Description
4216 Syntax server-get-xy
4219 \begin_layout Subsection*
4222 \begin_layout Description
4223 Action Generates the code (literate programming).
4225 \begin_layout Description
4226 Notion Latex file with extension
4228 literate_extension is generated. Then LyX invokes
4230 build_command (with a default of``make'') to generate the code and
4232 build_error_filter to process the compilation error messages.
4233 \begin_inset Newline newline
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
4242 build_command "my_script my_arguments"
4243 \begin_inset Newline newline
4248 build_error_filter differs from the
4250 literate_error_filter only in that the former will identify error messages from your compiler.
4252 \begin_layout Description
4253 Syntax build-program
4256 \begin_layout Subsection*
4257 LFUN_BUFFER_AUTO_SAVE
4259 \begin_layout Description
4260 Action Saves the current buffer to a temporary file.
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.
4265 \begin_layout Description
4266 Syntax buffer-auto-save
4269 \begin_layout Subsection*
4270 LFUN_BUFFER_CHILD_OPEN
4272 \begin_layout Description
4273 Action Loads the given child document.
4275 \begin_layout Description
4276 Notion The current document is treated as a parent.
4278 \begin_layout Description
4279 Syntax buffer-child-open <FILE>
4281 \begin_layout Description
4282 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4284 \begin_layout Description
4285 Origin Ale, 28 May 1997
4288 \begin_layout Subsection*
4291 \begin_layout Description
4292 Action Runs chktex for the current document.
4294 \begin_layout Description
4295 Syntax buffer-chktex
4297 \begin_layout Description
4298 Origin Asger, 30 Oct 1997
4301 \begin_layout Subsection*
4302 LFUN_BUFFER_TOGGLE_COMPRESSION
4304 \begin_layout Description
4305 Action Toggles compression of the current document on/off.
4307 \begin_layout Description
4308 Syntax buffer-toggle-compression
4310 \begin_layout Description
4311 Origin bpeng, 27 Apr 2006
4314 \begin_layout Subsection*
4317 \begin_layout Description
4318 Action Closes the current buffer.
4320 \begin_layout Description
4321 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4323 \begin_layout Description
4327 \begin_layout Subsection*
4330 \begin_layout Description
4331 Action Exports the current buffer (document) to the given format.
4333 \begin_layout Description
4334 Syntax buffer-export <FORMAT>
4336 \begin_layout Description
4337 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.
4338 \begin_inset Newline newline
4341 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.
4343 \begin_layout Description
4344 Origin Lgb, 29 Jul 1997
4347 \begin_layout Subsection*
4348 LFUN_BUFFER_EXPORT_CUSTOM
4350 \begin_layout Description
4351 Action Exports the current buffer (document) from the given format using the given command on it.
4353 \begin_layout Description
4354 Syntax buffer-export-custom <FORMAT> <COMMAND>
4356 \begin_layout Description
4357 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4358 \begin_inset Newline newline
4361 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4363 \begin_layout Description
4364 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4366 \begin_layout Description
4367 Origin leeming, 27 Mar 2004
4370 \begin_layout Subsection*
4373 \begin_layout Description
4374 Action Prints the current document.
4376 \begin_layout Description
4377 Notion Many settings can be given via the preferences dialog.
4379 \begin_layout Description
4380 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4382 \begin_layout Description
4383 Params <TARGET> is either "printer" or "file".
4384 \begin_inset Newline newline
4387 <TARGER-NAME> is either "default" or file name or printer name.
4388 \begin_inset Newline newline
4391 <COMMAND> command ensuring the printing job.
4393 \begin_layout Description
4394 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4396 \begin_layout Description
4397 Origin leeming, 28 Mar 2004
4400 \begin_layout Subsection*
4403 \begin_layout Description
4404 Action Import a given file as a lyx document.
4406 \begin_layout Description
4407 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.
4409 \begin_layout Description
4410 Syntax buffer-import <FORMAT> [<FILE>]
4412 \begin_layout Description
4413 Origin Asger, 24 Jul 1998
4416 \begin_layout Subsection*
4419 \begin_layout Description
4420 Action Creates a new buffer (that is, document).
4422 \begin_layout Description
4423 Notion Implicit path can be set in Preferences dialog.
4425 \begin_layout Description
4426 Syntax buffer-new [<FILE>]
4428 \begin_layout Description
4429 Params <FILE>: filename of created file with absolute path.
4432 \begin_layout Subsection*
4433 LFUN_BUFFER_NEW_TEMPLATE
4435 \begin_layout Description
4436 Action Creates a new buffer (that is, document) from a template.
4438 \begin_layout Description
4439 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4441 \begin_layout Description
4442 Syntax buffer-new-template [<FILE>]
4444 \begin_layout Description
4445 Params <FILE>: filename of created file with absolute path.
4448 \begin_layout Subsection*
4451 \begin_layout Description
4452 Action Reverts opened document.
4454 \begin_layout Description
4455 Syntax buffer-reload
4457 \begin_layout Description
4458 Origin Asger, 2 Feb 1997
4461 \begin_layout Subsection*
4464 \begin_layout Description
4465 Action Switch to the given buffer.
4467 \begin_layout Description
4468 Notion This is useful also in case you need simultaneously more views of the edited document in different LyX windows.
4470 \begin_layout Description
4471 Syntax buffer-new-template <BUFFER>
4473 \begin_layout Description
4474 Params <BUFFER>: already opened document which is to be shown.
4477 \begin_layout Subsection*
4478 LFUN_BUFFER_TOGGLE_READ_ONLY
4480 \begin_layout Description
4481 Action Toggle editing mode of the current document between read/write and read-only.
4483 \begin_layout Description
4484 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.
4485 \begin_inset Newline newline
4488 If these operations fail, buffer won't be toggled.
4490 \begin_layout Description
4491 Syntax buffer-toggle-read-only
4493 \begin_layout Description
4494 Origin Lgb, 27 May 1997
4497 \begin_layout Subsection*
4500 \begin_layout Description
4501 Action Displays current buffer in chosen format.
4503 \begin_layout Description
4504 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.
4506 \begin_layout Description
4507 Syntax buffer-view [<FORMAT>]
4509 \begin_layout Description
4510 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.
4513 \begin_layout Subsection*
4516 \begin_layout Description
4517 Action Exports the current document and put the result into the temporary directory.
4519 \begin_layout Description
4520 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).
4522 \begin_layout Description
4523 Syntax buffer-update [<FORMAT>]
4525 \begin_layout Description
4526 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.
4528 \begin_layout Description
4529 Origin Dekel, 5 Aug 2000
4532 \begin_layout Subsection*
4535 \begin_layout Description
4536 Action Saves the current buffer.
4538 \begin_layout Description
4539 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.
4541 \begin_layout Description
4545 \begin_layout Subsection*
4546 LFUN_BUFFER_WRITE_AS
4548 \begin_layout Description
4549 Action Rename and save current buffer.
4551 \begin_layout Description
4552 Syntax buffer-write-as <FILENAME>
4554 \begin_layout Description
4555 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4558 \begin_layout Subsection*
4559 LFUN_BUFFER_WRITE_ALL
4561 \begin_layout Description
4562 Action Save all changed documents.
4564 \begin_layout Description
4565 Syntax buffer-write-all
4567 \begin_layout Description
4568 Origin rgh, gpothier 6 Aug 2007
4571 \begin_layout Subsection*
4574 \begin_layout Description
4575 Action Switch to the next opened document.
4577 \begin_layout Description
4578 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4580 \begin_layout Description
4584 \begin_layout Subsection*
4585 LFUN_BUFFER_PREVIOUS
4587 \begin_layout Description
4588 Action Switch to the previous opened document.
4590 \begin_layout Description
4591 Syntax buffer-previous
4594 \begin_layout Subsection*
4595 LFUN_MASTER_BUFFER_UPDATE
4597 \begin_layout Description
4598 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4600 \begin_layout Description
4601 Syntax master-buffer-update [<FORMAT>]
4603 \begin_layout Description
4604 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.
4606 \begin_layout Description
4607 Origin Tommaso, 20 Sep 2007
4610 \begin_layout Subsection*
4611 LFUN_MASTER_BUFFER_VIEW
4613 \begin_layout Description
4614 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4616 \begin_layout Description
4617 Syntax master-buffer-view [<FORMAT>]
4619 \begin_layout Description
4620 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.
4622 \begin_layout Description
4623 Origin Tommaso, 20 Sep 2007
4626 \begin_layout Subsection*
4627 LFUN_BUFFER_LANGUAGE
4629 \begin_layout Description
4630 Action Set language of the current document.
4632 \begin_layout Description
4633 Syntax buffer-language <LANG>
4635 \begin_layout Description
4636 Params <LANG>: language name. See lib/languages for list.
4638 \begin_layout Description
4639 Origin leeming, 30 Mar 2004
4642 \begin_layout Subsection*
4643 LFUN_BUFFER_SAVE_AS_DEFAULT
4645 \begin_layout Description
4646 Action Save the current document settings as default.
4648 \begin_layout Description
4649 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4651 \begin_layout Description
4652 Syntax buffer-save-as-default [<ARGS>]
4654 \begin_layout Description
4655 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4657 \begin_layout Description
4658 Origin leeming, 30 Mar 2004
4661 \begin_layout Subsection*
4662 LFUN_BUFFER_PARAMS_APPLY
4664 \begin_layout Description
4665 Action Apply the given settings to the current document.
4667 \begin_layout Description
4668 Syntax buffer-params-apply [<ARGS>]
4670 \begin_layout Description
4671 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4673 \begin_layout Description
4674 Origin leeming, 30 Mar 2004
4677 \begin_layout Subsection*
4680 \begin_layout Description
4681 Action Inserts another LyX file.
4683 \begin_layout Description
4684 Syntax file-insert [<FILE>]
4686 \begin_layout Description
4687 Params <FILE>: Filename to be inserted.
4690 \begin_layout Subsection*
4691 LFUN_FILE_INSERT_PLAINTEXT
4693 \begin_layout Description
4694 Action Inserts plain text file.
4696 \begin_layout Description
4697 Syntax file-insert-plaintext [<FILE>]
4699 \begin_layout Description
4700 Params <FILE>: Filename to be inserted.
4702 \begin_layout Description
4703 Origin CFO-G, 19 Nov 1997
4706 \begin_layout Subsection*
4707 LFUN_FILE_INSERT_PLAINTEXT_PARA
4709 \begin_layout Description
4710 Action Inserts plain text file as paragraph (i.e. join lines).
4712 \begin_layout Description
4713 Syntax file-insert-plaintext-para [<FILE>]
4715 \begin_layout Description
4716 Params <FILE>: Filename to be inserted.
4718 \begin_layout Description
4719 Origin Levon, 14 Feb 2001
4722 \begin_layout Subsection*
4725 \begin_layout Description
4726 Action Open LyX document.
4728 \begin_layout Description
4729 Syntax file-open [<FILE>]
4731 \begin_layout Description
4732 Params <FILE>: Filename to be opened.
4735 \begin_layout Subsection*
4738 \begin_layout Description
4739 Action Executes a command defined in a .def file.
4741 \begin_layout Description
4742 Notion The definitions are by default read from lib/commands/default.def.
4743 \begin_inset Newline newline
4746 A .def file allows to define a command with
4748 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).
4750 def_file "FileName" allows to include another .def file.
4751 \begin_inset Newline newline
4754 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.
4756 \begin_layout Description
4759 \begin_layout Description
4760 Params <NAME>: Name of the command that must be called.
4762 \begin_layout Description
4763 Origin broider, 2 Oct 2007
4766 \begin_layout Subsection*
4769 \begin_layout Description
4770 Action Simulate halting Meta key (Alt key on PCs).
4772 \begin_layout Description
4773 Notion Used for buffer editation not for GUI control.
4775 \begin_layout Description
4779 \begin_layout Subsection*
4782 \begin_layout Description
4783 Action Cancels sequence prepared by LFUN_META_PREFIX .
4785 \begin_layout Description
4789 \begin_layout Subsection*
4790 LFUN_COMMAND_EXECUTE
4792 \begin_layout Description
4793 Action Opens the minibuffer toolbar so that the user can type in there.
4795 \begin_layout Description
4796 Notion Usually bound to M-x shortcut.
4798 \begin_layout Description
4799 Syntax command-execute
4802 \begin_layout Subsection*
4805 \begin_layout Description
4806 Action Return the current key sequence and available options as a string.
4808 \begin_layout Description
4809 Notion No options are added if no current map exists.
4810 \begin_inset Newline newline
4813 This is probably usable only with connection to lyxserver.
4815 \begin_layout Description
4816 Syntax command-prefix
4819 \begin_layout Subsection*
4820 LFUN_COMMAND_SEQUENCE
4822 \begin_layout Description
4823 Action Run more commands (LFUN and its parameters) in a sequence.
4825 \begin_layout Description
4826 Syntax command-sequence <CMDS>
4828 \begin_layout Description
4829 Params <CMDS>: Sequence of commands separated by semicolons.
4831 \begin_layout Description
4832 Sample command-sequence cut; ert-insert; self-insert
4834 ; paste; self-insert {}; inset-toggle;
4836 \begin_layout Description
4837 Origin Andre, 11 Nov 1999
4840 \begin_layout Subsection*
4841 LFUN_COMMAND_ALTERNATIVES
4843 \begin_layout Description
4844 Action Runs the first listed command that is enabled.
4846 \begin_layout Description
4847 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4849 \begin_layout Description
4850 Syntax command-alternatives <CMDS>
4852 \begin_layout Description
4853 Params <CMDS>: Sequence of commands separated by semicolons.
4855 \begin_layout Description
4856 Sample command-alternatives completion-accept;cell-forward
4858 \begin_layout Description
4859 Origin rgh, 24 September 2008
4862 \begin_layout Subsection*
4865 \begin_layout Description
4866 Action Shows message in statusbar (for script purposes).
4868 \begin_layout Description
4869 Syntax message <STRING>
4871 \begin_layout Description
4872 Origin Lgb, 8 Apr 2001
4875 \begin_layout Subsection*
4876 LFUN_PREFERENCES_SAVE
4878 \begin_layout Description
4879 Action Save user preferences.
4881 \begin_layout Description
4882 Syntax preferences-save
4884 \begin_layout Description
4885 Origin Lgb, 27 Nov 1999
4888 \begin_layout Subsection*
4891 \begin_layout Description
4892 Action Reconfigure the automatic settings.
4894 \begin_layout Description
4897 \begin_layout Description
4898 Origin Asger, 14 Feb 1997
4901 \begin_layout Subsection*
4904 \begin_layout Description
4905 Action Apply the given settings to user preferences.
4907 \begin_layout Description
4908 Syntax lyxrc-apply <SETTINGS>
4910 \begin_layout Description
4911 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.
4914 \begin_layout Subsection*
4915 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
4917 \begin_layout Description
4918 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
4920 \begin_layout Description
4921 Syntax toggle-cursor-follows-scrollbar
4923 \begin_layout Description
4924 Origin ARRae, 2 Dec 1997
4927 \begin_layout Subsection*
4930 \begin_layout Description
4931 Action Set the given LyX color to the color defined by the X11 name given.
4933 \begin_layout Description
4934 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
4936 \begin_layout Description
4937 Syntax set-color <LYX_NAME> <X11_NAME>
4939 \begin_layout Description
4940 Origin SLior, 11 Jun 2000
4943 \begin_layout Subsection*
4946 \begin_layout Description
4947 Action Count the statistics (number of words and characters) in the document or in the given selection.
4949 \begin_layout Description
4950 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
4952 \begin_layout Description
4955 \begin_layout Description
4956 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
4959 \begin_layout Subsection*
4960 LFUN_COMPLETION_INLINE
4962 \begin_layout Description
4963 Action Show the inline completion at the cursor position.
4965 \begin_layout Description
4966 Syntax completion-inline
4968 \begin_layout Description
4969 Origin sts, Feb 19 2008
4972 \begin_layout Subsection*
4973 LFUN_COMPLETION_POPUP
4975 \begin_layout Description
4976 Action Show the completion popup at the cursor position.
4978 \begin_layout Description
4979 Syntax completion-popup
4981 \begin_layout Description
4982 Origin sts, Feb 19 2008
4985 \begin_layout Subsection*
4986 LFUN_COMPLETION_COMPLETE
4988 \begin_layout Description
4989 Action Try to complete the word or command at the cursor position.
4991 \begin_layout Description
4994 \begin_layout Description
4995 Origin sts, Feb 19 2008
4998 \begin_layout Subsection*
4999 LFUN_COMPLETION_CANCEL
5001 \begin_layout Description
5002 Action Try to cancel completion, either the popup or the inline completion.
5004 \begin_layout Description
5005 Syntax completion-cancel
5007 \begin_layout Description
5008 Origin sts, Sep 07 2008
5011 \begin_layout Subsection*
5012 LFUN_COMPLETION_ACCEPT
5014 \begin_layout Description
5015 Action Accept suggested completion.
5017 \begin_layout Description
5018 Syntax completion-accept
5020 \begin_layout Description
5021 Origin sanda, Sep 08 2008
5024 \begin_layout Subsection*
5027 \begin_layout Description
5028 Action Add a branch to the buffer's BranchList.
5030 \begin_layout Description
5031 Syntax branch-add <BRANCH>
5033 \begin_layout Description
5034 Params <BRANCH>: Name of the branch to add
5036 \begin_layout Description
5037 Origin spitz, 7 Jul 2009
5040 \begin_layout Subsection*
5041 LFUN_BRANCH_ACTIVATE
5043 \begin_layout Description
5044 Action Activate the branch.
5046 \begin_layout Description
5047 Syntax branch-activate <BRANCH>
5049 \begin_layout Description
5050 Params <BRANCH>: The branch to activate
5052 \begin_layout Description
5053 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5054 \begin_inset Newline newline
5057 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5059 \begin_layout Description
5060 Origin rgh, 27 May 2008
5063 \begin_layout Subsection*
5064 LFUN_BRANCH_DEACTIVATE
5066 \begin_layout Description
5067 Action De-activate the branch.
5069 \begin_layout Description
5070 Syntax branch-deactivate <BRANCH>
5072 \begin_layout Description
5073 Params <BRANCH>: The branch to deactivate
5075 \begin_layout Description
5076 Origin rgh, 27 May 2008
5079 \begin_layout Subsection*
5080 LFUN_BRANCHES_RENAME
5082 \begin_layout Description
5083 Action Rename all branches of a given name in a document.
5085 \begin_layout Description
5086 Syntax branches-rename <OLDNAME> <NEWNAME>
5088 \begin_layout Description
5089 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5091 \begin_layout Description
5092 Origin spitz, 9 Jul 2009
5095 \begin_layout Subsection*
5096 LFUN_BRANCH_ADD_INSERT
5098 \begin_layout Description
5099 Action Create new branch and directly put the branch inset into the document.
5101 \begin_layout Description
5102 Syntax branch-add-insert [<NAME>]
5104 \begin_layout Description
5105 Params <NAME>: Branch name. If it is not specified, you will be asked.
5107 \begin_layout Description
5108 Origin sanda, 10 Jul 2009
5111 \begin_layout Subsection*
5112 LFUN_LABEL_COPY_AS_REF
5114 \begin_layout Description
5115 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5117 \begin_layout Description
5118 Syntax copy-label-as-reference <LABEL>
5120 \begin_layout Description
5121 Params <LABEL>: The label to copy (for multi-line math)
5123 \begin_layout Description
5124 Origin sts, 16 Nov 2008
5127 \begin_layout Subsection*
5128 LFUN_LABEL_INSERT_AS_REF
5130 \begin_layout Description
5131 Action Inserts the label as a cross-reference at the position of the cursor.
5133 \begin_layout Description
5134 Syntax label-insert-as-reference
5136 \begin_layout Description
5137 Origin vfr, 7 Apr 2009
5140 \begin_layout Subsection*
5143 \begin_layout Description
5144 Action Increases the zoom of the screen fonts.
5146 \begin_layout Description
5147 Syntax buffer-zoom-in [<ZOOM>]
5149 \begin_layout Description
5150 Params <ZOOM>: The zoom in %, the default is 20.
5152 \begin_layout Description
5153 Origin vfr, 30 Mar 2009
5156 \begin_layout Subsection*
5157 LFUN_BUFFER_ZOOM_OUT
5159 \begin_layout Description
5160 Action Decreases the zoom of the screen fonts.
5162 \begin_layout Description
5163 Syntax buffer-zoom-out [<ZOOM>]
5165 \begin_layout Description
5166 Params <ZOOM>: The zoom in %, the default is 20.
5168 \begin_layout Description
5169 Origin vfr, 30 Mar 2009
5172 \begin_layout Subsection*
5175 \begin_layout Description
5176 Action Selects the whole section.
5178 \begin_layout Description
5179 Notion The cursor should be in a section heading before calling this lfun.
5181 \begin_layout Description
5182 Syntax section-select
5184 \begin_layout Description
5185 Origin vfr, 05 May 2009