1 # gen_lfuns.py generated this file. For more info see http://www.lyx.org/
7 \renewcommand{\descriptionlabel}[1]{\hspace\labelsep\upshape\bfseries #1:}
8 \renewenvironment{description}{\list{}{%
9 \setlength{\itemsep}{-2pt}
10 \advance\leftmargini6\p@ \itemindent-12\p@
11 \labelwidth\z@ \let\makelabel\descriptionlabel}%
16 \use_default_options false
21 \font_typewriter default
22 \font_default_family default
29 \paperfontsize default
38 \paperorientation portrait
45 \paragraph_separation indent
47 \quotes_language english
50 \paperpagestyle default
51 \tracking_changes false
59 \begin_layout Section*
60 LFUNs documentation automatically generated 2010-02-12
63 \begin_layout Standard
67 \begin_layout Plain Layout
77 \begin_inset VSpace 1cm
82 \begin_layout Subsection*
85 \begin_layout Description
86 Action Adds an acute accent to the next character typed.
88 \begin_layout Description
92 \begin_layout Subsection*
95 \begin_layout Description
96 Action Adds a breve accent to the next character typed.
98 \begin_layout Description
102 \begin_layout Subsection*
105 \begin_layout Description
106 Action Adds a caron to the next character typed.
108 \begin_layout Description
112 \begin_layout Subsection*
115 \begin_layout Description
116 Action Adds a cedilla to the next character typed.
118 \begin_layout Description
119 Syntax accent-cedilla
122 \begin_layout Subsection*
125 \begin_layout Description
126 Action Adds a circle accent to the next character typed.
128 \begin_layout Description
132 \begin_layout Subsection*
133 LFUN_ACCENT_CIRCUMFLEX
135 \begin_layout Description
136 Action Adds a circumflex to the next character typed.
138 \begin_layout Description
139 Syntax accent-circumflex
142 \begin_layout Subsection*
145 \begin_layout Description
146 Action Adds a dot accent to the next character typed.
148 \begin_layout Description
152 \begin_layout Subsection*
155 \begin_layout Description
156 Action Adds a grave accent to the next character typed.
158 \begin_layout Description
162 \begin_layout Subsection*
163 LFUN_ACCENT_HUNGARIAN_UMLAUT
165 \begin_layout Description
166 Action Adds a Hungarian umlaut to the next character typed.
168 \begin_layout Description
172 \begin_layout Subsection*
175 \begin_layout Description
176 Action Adds a macron to the next character typed.
178 \begin_layout Description
182 \begin_layout Subsection*
185 \begin_layout Description
186 Action Adds an ogonek accent to the next character typed.
188 \begin_layout Description
192 \begin_layout Subsection*
195 \begin_layout Description
196 Action Adds a tie over the next two character typed.
198 \begin_layout Description
199 Notion The following char will finish the tie.
201 \begin_layout Description
205 \begin_layout Subsection*
208 \begin_layout Description
209 Action Adds a tilde over the next character typed.
211 \begin_layout Description
215 \begin_layout Subsection*
218 \begin_layout Description
219 Action Adds an umlaut over the next character typed.
221 \begin_layout Description
225 \begin_layout Subsection*
228 \begin_layout Description
229 Action Adds a bar under the next character typed.
231 \begin_layout Description
232 Syntax accent-underbar
235 \begin_layout Subsection*
238 \begin_layout Description
239 Action Adds a dot under the next character typed.
241 \begin_layout Description
242 Syntax accent-underdot
245 \begin_layout Subsection*
248 \begin_layout Description
249 Action Inserts a caption inset.
251 \begin_layout Description
252 Syntax caption-insert
254 \begin_layout Description
255 Origin Lgb, 18 Jul 2000
258 \begin_layout Subsection*
261 \begin_layout Description
262 Action Inserts the current date.
264 \begin_layout Description
265 Syntax date-insert [<ARG>]
267 \begin_layout Description
268 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.
270 \begin_layout Description
271 Origin jdblair, 31 Jan 2000
274 \begin_layout Subsection*
277 \begin_layout Description
278 Action Inserts a footnote inset.
280 \begin_layout Description
281 Syntax footnote-insert
283 \begin_layout Description
284 Origin Jug, 7 Mar 2000
287 \begin_layout Subsection*
290 \begin_layout Description
291 Action Inserts an ERT inset.
293 \begin_layout Description
296 \begin_layout Description
297 Origin Jug, 18 Feb 2000
300 \begin_layout Subsection*
303 \begin_layout Description
304 Action Inserts a float inset.
306 \begin_layout Description
307 Syntax float-insert <TYPE>
309 \begin_layout Description
310 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
312 \begin_layout Description
313 Origin Lgb, 27 Jun 2000
316 \begin_layout Subsection*
317 LFUN_FLOAT_WIDE_INSERT
319 \begin_layout Description
320 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
322 \begin_layout Description
323 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
325 \begin_layout Description
326 Syntax float-wide-insert <TYPE>
328 \begin_layout Description
329 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
331 \begin_layout Description
332 Origin Lgb, 31 Oct 2001
335 \begin_layout Subsection*
336 LFUN_FLOAT_LIST_INSERT
338 \begin_layout Description
339 Action Inserts the list of floats in the document.
341 \begin_layout Description
342 Syntax float-list-insert <TYPE>
344 \begin_layout Description
345 Params <TYPE>: type of float depends on the used textclass. Usually "algorithm", "table", "figure" parameters can be given.
347 \begin_layout Description
348 Origin Lgb, 3 May 2001
351 \begin_layout Subsection*
354 \begin_layout Description
355 Action Inserts floats wrapped by the text around.
357 \begin_layout Description
358 Syntax wrap-insert <TYPE>
360 \begin_layout Description
361 Params <TYPE>: table|figure
363 \begin_layout Description
364 Origin Dekel, 7 Apr 2002
367 \begin_layout Subsection*
370 \begin_layout Description
371 Action Inserts an optional-argument (short title) inset.
373 \begin_layout Description
374 Syntax optional-insert
376 \begin_layout Description
377 Origin vermeer, 12 Aug 2002
380 \begin_layout Subsection*
383 \begin_layout Description
384 Action Inserts a horizontal line.
386 \begin_layout Description
389 \begin_layout Description
390 Origin Andre, Oct 27 2003
393 \begin_layout Subsection*
396 \begin_layout Description
397 Action Inserts a new page.
399 \begin_layout Description
400 Syntax newpage-insert <ARG>
402 \begin_layout Description
403 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
405 \begin_layout Description
406 Origin uwestoehr, 24 Nov 2007
409 \begin_layout Subsection*
410 LFUN_MARGINALNOTE_INSERT
412 \begin_layout Description
413 Action Inserts a marginal note.
415 \begin_layout Description
416 Syntax marginalnote-insert
418 \begin_layout Description
419 Origin Lgb, 26 Jun 2000
422 \begin_layout Subsection*
425 \begin_layout Description
426 Action Inserts a single unicode character.
428 \begin_layout Description
429 Syntax unicode-insert <CHAR>
431 \begin_layout Description
432 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
434 \begin_layout Description
435 Sample unicode-insert 0x0100
437 \begin_layout Description
438 Origin Lgb, 22 Oct 2006
441 \begin_layout Subsection*
444 \begin_layout Description
445 Action Inserts a new listings inset.
447 \begin_layout Description
448 Syntax listing-insert
450 \begin_layout Description
451 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
454 \begin_layout Subsection*
457 \begin_layout Description
458 Action Insert a tab into a listings inset.
460 \begin_layout Description
461 Notion It also works on a selection.
463 \begin_layout Description
466 \begin_layout Description
467 Origin vfr, Sep 30 2008
470 \begin_layout Subsection*
473 \begin_layout Description
474 Action Delete a tab or up to an equivalent amount of spaces from a listings inset.
476 \begin_layout Description
477 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.
479 \begin_layout Description
482 \begin_layout Description
483 Origin vfr, Sep 30 2008
486 \begin_layout Subsection*
489 \begin_layout Description
490 Action Inserts quotes according to the type and quote-language preference.
492 \begin_layout Description
493 Notion Currently English, Swedish, German, Polish, French, Danish quotes are distinguished.
495 \begin_layout Description
496 Syntax quote-insert [<TYPE>]
498 \begin_layout Description
499 Params <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
502 \begin_layout Subsection*
505 \begin_layout Description
506 Action Displays shortcuts, lyxrc, package and textclass availability and menu information in a non-editable boxed InsetText.
508 \begin_layout Description
509 Notion Apart from lfun arguments you can use the following method:
510 \begin_inset Newline newline
513 1. input the type and argument of this inset, e.g. "menu paste", in the work area.
514 \begin_inset Newline newline
517 2. select the text and run info-insert lfun.
519 \begin_layout Description
520 Syntax info-insert <TYPE> <ARG>
522 \begin_layout Description
523 Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
524 \begin_inset Newline newline
527 <ARG>: argument for a given type. Look into InsetInfo.h for detailed description.
528 \begin_inset Newline newline
531 shortcut[s]: name of lfun (e.g math-insert
534 \begin_inset Newline newline
537 lyxrc: name of rc_entry (e.g. bind_file)
538 \begin_inset Newline newline
541 package: name of latex package (e.g. listings)
542 \begin_inset Newline newline
545 textclass: name of textclass (e.g. article)
546 \begin_inset Newline newline
549 menu: name of lfun used in menu
550 \begin_inset Newline newline
553 icon: name of lfun used in toolbar
554 \begin_inset Newline newline
557 buffer: "name"|"path"|"class"|"vcs-tree-revision"| "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
559 \begin_layout Description
560 Sample command-sequence info-insert buffer path; info-insert buffer name
562 \begin_layout Description
563 Origin bpeng, 7 Oct 2007
566 \begin_layout Subsection*
569 \begin_layout Description
570 Action Inserts branch inset.
572 \begin_layout Description
573 Syntax branch-insert <BRANCH-NAME>
575 \begin_layout Description
576 Origin vermeer, 17 Aug 2003
579 \begin_layout Subsection*
582 \begin_layout Description
583 Action Inserts Box inset.
585 \begin_layout Description
586 Syntax box-insert [<TYPE>]
588 \begin_layout Description
589 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
590 \begin_inset Newline newline
593 Framed is the default one.
595 \begin_layout Description
596 Origin vermeer, 7 Oct 2003
599 \begin_layout Subsection*
602 \begin_layout Description
603 Action Inserts CharStyle, Custom inset or XML short element.
605 \begin_layout Description
606 Notion Look into the Customization manual for more information about these elements.
607 \begin_inset Newline newline
610 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.
611 \begin_inset Newline newline
614 For dissolving the element see LFUN_INSET_DISSOLVE.
616 \begin_layout Description
617 Syntax flex-insert <TYPE:Name>
619 \begin_layout Description
620 Params TYPE: CharStyle|Custom|Element|Standard
621 \begin_inset Newline newline
624 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.
625 \begin_inset Newline newline
628 Name: This name must be defined either in your layout file or imported by some module. The definition is InsetLayout <TYPE:Name>
630 \begin_layout Description
631 Sample flex-insert CharStyle:Code
634 \begin_layout Subsection*
637 \begin_layout Description
638 Action Inserts the given string (accordingly to the correct keymap).
640 \begin_layout Description
641 Notion Automatically replace the currently selected text. Depends on lyxrc settings "auto_region_delete".
643 \begin_layout Description
644 Syntax self-insert <STRING>
647 \begin_layout Subsection*
650 \begin_layout Description
651 Action Inserts one of horizontal space insets.
653 \begin_layout Description
654 Syntax space-insert <NAME> [<LEN>]
656 \begin_layout Description
657 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspace, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
658 \begin_inset Newline newline
661 <LEN>: length for custom spaces (hspace, hspace* for protected)
663 \begin_layout Description
664 Origin JSpitzm, 20 May 2003, Mar 17 2008
667 \begin_layout Subsection*
668 LFUN_HYPERLINK_INSERT
670 \begin_layout Description
671 Action Inserts hyperlinks into the document (clickable in pdf output).
673 \begin_layout Description
674 Notion Hyperlink target can be set via selection + hyperlink-insert function.
676 \begin_layout Description
677 Syntax href-insert [<TARGET>]
679 \begin_layout Description
680 Origin CFO-G, 21 Nov 1997
683 \begin_layout Subsection*
684 LFUN_SPECIALCHAR_INSERT
686 \begin_layout Description
687 Action Inserts various characters into the document.
689 \begin_layout Description
690 Syntax specialchar-insert <CHAR>
692 \begin_layout Description
693 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sentence, menu-separator.
695 \begin_layout Description
696 Origin JSpitzm, 6 Dec 2007
699 \begin_layout Subsection*
702 \begin_layout Description
703 Action Inserts table of contents.
705 \begin_layout Description
708 \begin_layout Description
709 Origin Lgb, 27 May 97
712 \begin_layout Subsection*
715 \begin_layout Description
716 Action Start (or remove) Appendix on the given cursor position.
718 \begin_layout Description
721 \begin_layout Description
722 Origin ettrich, 5 May 1998
725 \begin_layout Subsection*
728 \begin_layout Description
729 Action Inserts Index entry.
731 \begin_layout Description
732 Notion It automatically takes the word on the cursor position.
734 \begin_layout Description
735 Syntax index-insert [<TYPE:Name>]
737 \begin_layout Description
738 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
740 \begin_layout Description
741 Origin leeming, 3 Aug 2000
744 \begin_layout Subsection*
747 \begin_layout Description
748 Action Inserts list of Index entries on a new page.
750 \begin_layout Description
751 Syntax index-print [<TYPE:Name>]
753 \begin_layout Description
754 Params <TYPE:Name>: name of the index, if multiple indices are defined. with an empty argument, the default index is selected.
756 \begin_layout Description
757 Origin Lgb, 27 Feb 1997
760 \begin_layout Subsection*
763 \begin_layout Description
764 Action Inserts Nomenclature entry.
766 \begin_layout Description
767 Notion It automatically takes the word on the cursor position if no symbol is given.
769 \begin_layout Description
770 Syntax nomencl-insert [<SYMBOL>]
772 \begin_layout Description
773 Origin Ugras, 4 Nov 2006
776 \begin_layout Subsection*
777 LFUN_NOMENCLATURE_PRINT
779 \begin_layout Description
780 Action Inserts list of Nomenclature entries.
782 \begin_layout Description
783 Syntax nomenclature-print
785 \begin_layout Description
786 Origin Ugras, 4 Nov 2006
789 \begin_layout Subsection*
792 \begin_layout Description
793 Action Inserts Note on the current cursor postion, move selection inside the inset.
795 \begin_layout Description
796 Syntax note-insert [<TYPE>]
798 \begin_layout Description
799 Params <TYPE>: <Note|Greyedout|Comment> default: Note
802 \begin_layout Subsection*
805 \begin_layout Description
806 Action Moves the cursor to the begining of next Note inset.
808 \begin_layout Description
812 \begin_layout Subsection*
815 \begin_layout Description
816 Action Inserts phantom on the current cursor postion, move selection inside the inset.
818 \begin_layout Description
819 Syntax phantom-insert [<TYPE>]
821 \begin_layout Description
822 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
824 \begin_layout Description
825 Origin uwestoehr, 30 Jan 2009
828 \begin_layout Subsection*
831 \begin_layout Description
832 Action Inserts a line break or new line.
834 \begin_layout Description
835 Syntax newline-insert [<ARG>]
837 \begin_layout Description
838 Params <ARG>: <newline|linebreak> default: newline
840 \begin_layout Description
841 Origin JSpitzm, 25 Mar 2008
844 \begin_layout Subsection*
847 \begin_layout Description
848 Action Clears the selection. If no text is selected call LFUN_FINISHED_FORWARD.
850 \begin_layout Description
853 \begin_layout Description
854 Origin Lgb, 17 May 2001
857 \begin_layout Subsection*
860 \begin_layout Description
861 Action Moves the cursor one line in downward direction.
863 \begin_layout Description
867 \begin_layout Subsection*
870 \begin_layout Description
871 Action Moves the cursor one line in upward direction.
873 \begin_layout Description
877 \begin_layout Subsection*
880 \begin_layout Description
881 Action Moves the cursor one line in downward direction adding the current position to the selection.
883 \begin_layout Description
887 \begin_layout Subsection*
890 \begin_layout Description
891 Action Moves the cursor one line in upward direction adding the current position to the selection.
893 \begin_layout Description
897 \begin_layout Subsection*
900 \begin_layout Description
901 Action Moves the cursor one page in downward direction.
903 \begin_layout Description
907 \begin_layout Subsection*
910 \begin_layout Description
911 Action Moves the cursor one page in upward direction.
913 \begin_layout Description
917 \begin_layout Subsection*
918 LFUN_SCREEN_DOWN_SELECT
920 \begin_layout Description
921 Action Moves the cursor one screen in downward direction adding the current position to the selection.
923 \begin_layout Description
924 Syntax screen-down-select
927 \begin_layout Subsection*
928 LFUN_SCREEN_UP_SELECT
930 \begin_layout Description
931 Action Moves the cursor one page in upward direction adding the current position to the selection.
933 \begin_layout Description
934 Syntax screen-up-select
937 \begin_layout Subsection*
940 \begin_layout Description
941 Action Scroll the buffer view.
943 \begin_layout Description
944 Notion Only scrolls the screen up or down; does not move the cursor.
946 \begin_layout Description
947 Syntax scroll <TYPE> <QUANTITY>
949 \begin_layout Description
950 Params <TYPE>: line|page
951 \begin_inset Newline newline
954 <QUANTITY>: up|down|<number>
956 \begin_layout Description
957 Origin Abdel, Dec 27 2007
960 \begin_layout Subsection*
963 \begin_layout Description
964 Action Recenters the screen on the current cursor position.
966 \begin_layout Description
967 Syntax screen-recenter
970 \begin_layout Subsection*
971 LFUN_SCREEN_SHOW_CURSOR
973 \begin_layout Description
974 Action Repositions the screen such that the cursor is visible.
976 \begin_layout Description
977 Syntax screen-show-cursor
979 \begin_layout Description
980 Origin vfr, 25 Mar 2009
983 \begin_layout Subsection*
986 \begin_layout Description
987 Action Moves the cursor one position logically backwards.
989 \begin_layout Description
990 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.
992 \begin_layout Description
996 \begin_layout Subsection*
997 LFUN_CHAR_BACKWARD_SELECT
999 \begin_layout Description
1000 Action Moves the cursor one position logically backwards, adding traversed position to the selection.
1002 \begin_layout Description
1003 Notion See also LFUN_CHAR_BACKWARD.
1005 \begin_layout Description
1006 Syntax char-backward-select
1009 \begin_layout Subsection*
1010 LFUN_CHAR_DELETE_BACKWARD
1012 \begin_layout Description
1013 Action Deletes one character in the backward direction (usually the "BackSpace" key).
1015 \begin_layout Description
1016 Syntax char-delete-backward
1019 \begin_layout Subsection*
1020 LFUN_CHAR_DELETE_FORWARD
1022 \begin_layout Description
1023 Action Deletes one character in the backward direction (usually the "Delete" key).
1025 \begin_layout Description
1026 Syntax char-delete-forward
1029 \begin_layout Subsection*
1032 \begin_layout Description
1033 Action Moves the cursor one position logically forward.
1035 \begin_layout Description
1036 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.
1038 \begin_layout Description
1042 \begin_layout Subsection*
1043 LFUN_CHAR_FORWARD_SELECT
1045 \begin_layout Description
1046 Action Moves the cursor one position logically forward, adding traversed position to the selection.
1048 \begin_layout Description
1049 Notion See also LFUN_CHAR_FORWARD.
1051 \begin_layout Description
1052 Syntax char-forward-select
1055 \begin_layout Subsection*
1058 \begin_layout Description
1059 Action Moves the cursor one position "to the left".
1061 \begin_layout Description
1062 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.
1064 \begin_layout Description
1068 \begin_layout Subsection*
1069 LFUN_CHAR_LEFT_SELECT
1071 \begin_layout Description
1072 Action Moves the cursor one position "to the left", adding traversed position to the selection.
1074 \begin_layout Description
1075 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1077 \begin_layout Description
1078 Syntax char-left-select
1081 \begin_layout Subsection*
1084 \begin_layout Description
1085 Action Moves the cursor one position "to the right".
1087 \begin_layout Description
1088 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.
1090 \begin_layout Description
1094 \begin_layout Subsection*
1095 LFUN_CHAR_RIGHT_SELECT
1097 \begin_layout Description
1098 Action Moves the cursor one position "to the right", adding traversed position to the selection.
1100 \begin_layout Description
1101 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1103 \begin_layout Description
1104 Syntax char-right-select
1107 \begin_layout Subsection*
1110 \begin_layout Description
1111 Action Moves the cursor to the logically previous beginning of a word.
1113 \begin_layout Description
1114 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.
1116 \begin_layout Description
1117 Syntax word-backward
1120 \begin_layout Subsection*
1121 LFUN_WORD_BACKWARD_SELECT
1123 \begin_layout Description
1124 Action Moves the cursor to the logically previous beginning of a word, adding the logically traversed text to the selection.
1126 \begin_layout Description
1127 Notion See also LFUN_WORD_BACKWARD.
1129 \begin_layout Description
1130 Syntax word-backward-select
1133 \begin_layout Subsection*
1134 LFUN_WORD_DELETE_BACKWARD
1136 \begin_layout Description
1137 Action Deletes characters to the begining of the word (usually the "C+BackSpace" key).
1139 \begin_layout Description
1140 Syntax word-delete-backward
1143 \begin_layout Subsection*
1144 LFUN_WORD_DELETE_FORWARD
1146 \begin_layout Description
1147 Action Deletes characters to the end of the word (usually the "C+Delete" key).
1149 \begin_layout Description
1150 Syntax word-delete-forward
1153 \begin_layout Subsection*
1154 LFUN_WORD_FIND_FORWARD
1156 \begin_layout Description
1157 Action Search for a given string in forward direction.
1159 \begin_layout Description
1160 Notion Case sensitive, match words. If no argument given, last search repeated.
1162 \begin_layout Description
1163 Syntax word-find-forward [<STRING>]
1165 \begin_layout Description
1166 Origin Etienne, 16 Feb 1998
1169 \begin_layout Subsection*
1170 LFUN_WORD_FIND_BACKWARD
1172 \begin_layout Description
1173 Action Search for a given string in backward direction.
1175 \begin_layout Description
1176 Notion Case sensitive, match words. If no argument given, last search repeated.
1178 \begin_layout Description
1179 Syntax word-find-backward [<STRING>]
1181 \begin_layout Description
1182 Origin Etienne, 20 Feb 1998
1185 \begin_layout Subsection*
1188 \begin_layout Description
1189 Action Search for next occurence of a string.
1191 \begin_layout Description
1192 Syntax word-find [<DATA>]
1194 \begin_layout Description
1195 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).
1197 \begin_layout Description
1198 Origin Andre, Jan 7 2004
1201 \begin_layout Subsection*
1204 \begin_layout Description
1205 Action Replace a string in the document.
1207 \begin_layout Description
1208 Syntax word-replace [<DATA>]
1210 \begin_layout Description
1211 Params <DATA>: data is of the form "<replace>
1212 \begin_inset Newline newline
1216 \begin_inset Newline newline
1219 <casesensitive> <matchword> <all> <forward>"
1221 \begin_layout Description
1222 Origin Andre, Jan 7 2004
1225 \begin_layout Subsection*
1228 \begin_layout Description
1229 Action Search for next occurence of a pattern.
1231 \begin_layout Description
1232 Syntax word-findadv [<DATA>]
1234 \begin_layout Description
1235 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).
1237 \begin_layout Description
1238 Origin Tommaso, Nov 15 2007
1241 \begin_layout Subsection*
1244 \begin_layout Description
1245 Action Moves the cursor to the logically next beginning of a word.
1247 \begin_layout Description
1248 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.
1250 \begin_layout Description
1254 \begin_layout Subsection*
1255 LFUN_WORD_FORWARD_SELECT
1257 \begin_layout Description
1258 Action Moves the cursor to the logically next beginning of a word, adding the logically traversed text to the selection.
1260 \begin_layout Description
1261 Notion See also LFUN_WORD_FORWARD.
1263 \begin_layout Description
1264 Syntax word-forward-select
1267 \begin_layout Subsection*
1270 \begin_layout Description
1271 Action Moves the cursor to the next beginning of a word "on the left".
1273 \begin_layout Description
1274 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.
1276 \begin_layout Description
1279 \begin_layout Description
1280 Origin dov, 28 Oct 2007
1283 \begin_layout Subsection*
1284 LFUN_WORD_LEFT_SELECT
1286 \begin_layout Description
1287 Action Moves the cursor to the next beginning of a word "on the left", adding *logically* traversed text to the selection.
1289 \begin_layout Description
1290 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1292 \begin_layout Description
1293 Syntax word-left-select
1295 \begin_layout Description
1296 Origin dov, 28 Oct 2007
1299 \begin_layout Subsection*
1302 \begin_layout Description
1303 Action Moves the cursor to the next beginning of a word "on the right".
1305 \begin_layout Description
1306 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.
1308 \begin_layout Description
1311 \begin_layout Description
1312 Origin dov, 28 Oct 2007
1315 \begin_layout Subsection*
1316 LFUN_WORD_RIGHT_SELECT
1318 \begin_layout Description
1319 Action Moves the cursor to the next beginning of a word "on the right", adding *logically* traversed text to the selection.
1321 \begin_layout Description
1322 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1324 \begin_layout Description
1325 Syntax word-right-select
1327 \begin_layout Description
1328 Origin dov, 28 Oct 2007
1331 \begin_layout Subsection*
1334 \begin_layout Description
1335 Action Puts the word where the cursor stands into the selection.
1337 \begin_layout Description
1340 \begin_layout Description
1341 Origin Andre, 11 Sep 2002
1344 \begin_layout Subsection*
1345 LFUN_WORD_CAPITALIZE
1347 \begin_layout Description
1348 Action Capitalizes the words in the selection (i.e. the first letters) or the letter on the cursor position.
1350 \begin_layout Description
1351 Syntax word-capitalize
1354 \begin_layout Subsection*
1357 \begin_layout Description
1358 Action Change the words in the selection or from the cursor position to the end of word to the upper case.
1360 \begin_layout Description
1364 \begin_layout Subsection*
1367 \begin_layout Description
1368 Action Change the words in the selection or from the cursor position to the end of word to the lower case.
1370 \begin_layout Description
1374 \begin_layout Subsection*
1377 \begin_layout Description
1378 Action Add the word under the cursor to the respective spell checker dictionary.
1380 \begin_layout Description
1381 Syntax spelling-add [<STRING>] [<LANG>]
1383 \begin_layout Description
1384 Params <WORD>: word to add <LANG>: language name (see file languages)
1386 \begin_layout Description
1387 Origin JSpitzm, 18 Jan 2010
1390 \begin_layout Subsection*
1391 LFUN_SPELLING_IGNORE
1393 \begin_layout Description
1394 Action Let the spell checker ignore the word under the cursor in the current session for the given language.
1396 \begin_layout Description
1397 Syntax spelling-ignore [<WORD>] [<LANG>]
1399 \begin_layout Description
1400 Params <WORD>: word to ignore <LANG>: language name (see file languages)
1402 \begin_layout Description
1403 Origin JSpitzm, 18 Jan 2010
1406 \begin_layout Subsection*
1407 LFUN_THESAURUS_ENTRY
1409 \begin_layout Description
1410 Action Look up thesaurus entries with respect to the word under the cursor.
1412 \begin_layout Description
1413 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1415 \begin_layout Description
1416 Params <STRING>: word to look up <LANG>: language (see file languages)
1418 \begin_layout Description
1419 Origin Levon, 20 Jul 2001
1422 \begin_layout Subsection*
1425 \begin_layout Description
1426 Action Move the cursor to the beginning of the document.
1428 \begin_layout Description
1432 \begin_layout Subsection*
1433 LFUN_BUFFER_BEGIN_SELECT
1435 \begin_layout Description
1436 Action Move the cursor to the beginning of the document adding the traversed text to the selection.
1438 \begin_layout Description
1439 Syntax buffer-begin-select
1442 \begin_layout Subsection*
1445 \begin_layout Description
1446 Action Move the cursor to the end of the document.
1448 \begin_layout Description
1452 \begin_layout Subsection*
1453 LFUN_BUFFER_END_SELECT
1455 \begin_layout Description
1456 Action Move the cursor to the end of the document adding the traversed text to the selection.
1458 \begin_layout Description
1459 Syntax buffer-end-select
1462 \begin_layout Subsection*
1465 \begin_layout Description
1466 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
1468 \begin_layout Description
1471 \begin_layout Description
1472 Origin lasgouttes, 16 Mar 2009
1475 \begin_layout Subsection*
1476 LFUN_INSET_BEGIN_SELECT
1478 \begin_layout Description
1479 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).
1481 \begin_layout Description
1482 Syntax inset-begin-select
1484 \begin_layout Description
1485 Origin lasgouttes, 16 Mar 2009
1488 \begin_layout Subsection*
1491 \begin_layout Description
1492 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
1494 \begin_layout Description
1497 \begin_layout Description
1498 Origin lasgouttes, 16 Mar 2009
1501 \begin_layout Subsection*
1502 LFUN_INSET_END_SELECT
1504 \begin_layout Description
1505 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).
1507 \begin_layout Description
1508 Syntax inset-end-select
1510 \begin_layout Description
1511 Origin lasgouttes, 16 Mar 2009
1514 \begin_layout Subsection*
1515 LFUN_INSET_SELECT_ALL
1517 \begin_layout Description
1518 Action Selects all contents of an inset.
1520 \begin_layout Description
1521 Syntax inset-select-all
1523 \begin_layout Description
1524 Origin vfr, 22 Aug 2009
1527 \begin_layout Subsection*
1530 \begin_layout Description
1531 Action Selects the whole section.
1533 \begin_layout Description
1534 Notion The cursor should be in a section heading before calling this lfun.
1536 \begin_layout Description
1537 Syntax section-select
1539 \begin_layout Description
1540 Origin vfr, 05 May 2009
1543 \begin_layout Subsection*
1546 \begin_layout Description
1547 Action Move the cursor to the begining of the (screen) line.
1549 \begin_layout Description
1553 \begin_layout Subsection*
1554 LFUN_LINE_BEGIN_SELECT
1556 \begin_layout Description
1557 Action Move the cursor to the beginning of the (screen) line adding the traversed text to the selection.
1559 \begin_layout Description
1560 Syntax line-begin-select
1563 \begin_layout Subsection*
1566 \begin_layout Description
1567 Action Move the cursor to the end of the (screen) line.
1569 \begin_layout Description
1573 \begin_layout Subsection*
1574 LFUN_LINE_END_SELECT
1576 \begin_layout Description
1577 Action Move the cursor to the end of the (screen) line adding the traversed text to the selection.
1579 \begin_layout Description
1580 Syntax line-end-select
1583 \begin_layout Subsection*
1586 \begin_layout Description
1587 Action Deletes the letters to the end of the (screen) line or deletes the selection.
1589 \begin_layout Description
1590 Syntax line-delete-forward
1593 \begin_layout Subsection*
1596 \begin_layout Description
1597 Action Copies to the clipboard the last edit.
1599 \begin_layout Description
1603 \begin_layout Subsection*
1606 \begin_layout Description
1607 Action Cuts to the clipboard.
1609 \begin_layout Description
1613 \begin_layout Subsection*
1616 \begin_layout Description
1617 Action Pastes material (text or picture) from the active clipboard.
1619 \begin_layout Description
1620 Syntax paste [<TYPE>|<NUM>]
1622 \begin_layout Description
1623 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
1624 \begin_inset Newline newline
1627 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1630 \begin_layout Subsection*
1631 LFUN_CLIPBOARD_PASTE
1633 \begin_layout Description
1634 Action Pastes text from the active clipboard.
1636 \begin_layout Description
1637 Syntax clipboard-paste [<ARG>]
1639 \begin_layout Description
1640 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1642 \begin_layout Description
1643 Origin baum, 10 Jul 2006
1646 \begin_layout Subsection*
1647 LFUN_PRIMARY_SELECTION_PASTE
1649 \begin_layout Description
1650 Action Pastes the currently text selected text.
1652 \begin_layout Description
1653 Notion Primary selection mechanism is linux-only thing.
1655 \begin_layout Description
1656 Syntax primary-selection-paste [<ARG>]
1658 \begin_layout Description
1659 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1662 \begin_layout Subsection*
1663 LFUN_SELECTION_PASTE
1665 \begin_layout Description
1666 Action Pastes the text in permanent selection.
1668 \begin_layout Description
1669 Syntax selection-paste
1672 \begin_layout Subsection*
1675 \begin_layout Description
1676 Action Undoes the last edit.
1678 \begin_layout Description
1682 \begin_layout Subsection*
1685 \begin_layout Description
1686 Action Redoes the last thing undone.
1688 \begin_layout Description
1692 \begin_layout Subsection*
1695 \begin_layout Description
1696 Action Repeat the given command.
1698 \begin_layout Description
1699 Syntax repeat <COUNT> <LFUN-COMMAND>
1701 \begin_layout Description
1702 Origin Andre, 27 Oct 2003
1705 \begin_layout Subsection*
1706 LFUN_CHARS_TRANSPOSE
1708 \begin_layout Description
1709 Action Transposes the character at the cursor with the one before it.
1711 \begin_layout Description
1712 Syntax chars-transpose
1714 \begin_layout Description
1715 Origin Lgb, 25 Apr 2001
1718 \begin_layout Subsection*
1719 LFUN_DEPTH_DECREMENT
1721 \begin_layout Description
1722 Action Decrease the nesting depth of the (selected) paragraph(s) inside lists.
1724 \begin_layout Description
1725 Syntax depth-decrement
1728 \begin_layout Subsection*
1729 LFUN_DEPTH_INCREMENT
1731 \begin_layout Description
1732 Action Increase the nesting depth of the (selected) paragraph(s) inside lists.
1734 \begin_layout Description
1735 Syntax depth-increment
1738 \begin_layout Subsection*
1741 \begin_layout Description
1742 Action Toggles the bold font (selection-wise) using mathbf in math.
1744 \begin_layout Description
1748 \begin_layout Subsection*
1749 LFUN_FONT_BOLDSYMBOL
1751 \begin_layout Description
1752 Action Toggles the bold font (selection-wise) using boldsymbol in math.
1754 \begin_layout Description
1755 Syntax font-boldsymbol
1758 \begin_layout Subsection*
1759 LFUN_FONT_TYPEWRITER
1761 \begin_layout Description
1762 Action Toggles the typewriter family font (selection-wise).
1764 \begin_layout Description
1765 Syntax font-typewriter
1768 \begin_layout Subsection*
1771 \begin_layout Description
1772 Action Toggles underline in the font (selection-wise).
1774 \begin_layout Description
1775 Syntax font-underline
1778 \begin_layout Subsection*
1781 \begin_layout Description
1782 Action Toggles double underline in the font (selection-wise).
1784 \begin_layout Description
1785 Syntax font-underunderline
1787 \begin_layout Description
1788 Origin sanda, 5 May 2009
1791 \begin_layout Subsection*
1794 \begin_layout Description
1795 Action Toggles wavy underline in the font (selection-wise).
1797 \begin_layout Description
1798 Syntax font-underwave
1800 \begin_layout Description
1801 Origin sanda, 5 May 2009
1804 \begin_layout Subsection*
1807 \begin_layout Description
1808 Action Toggles strikeout (strike-through) in the font (selection-wise).
1810 \begin_layout Description
1811 Syntax font-strikeout
1813 \begin_layout Description
1814 Origin sanda, 3 May 2009
1817 \begin_layout Subsection*
1820 \begin_layout Description
1821 Action Toggles the emphasis font style (selection-wise).
1823 \begin_layout Description
1827 \begin_layout Subsection*
1830 \begin_layout Description
1831 Action Toggles Noun text style font (selection-wise).
1833 \begin_layout Description
1837 \begin_layout Subsection*
1840 \begin_layout Description
1841 Action Toggles Roman family font (selection-wise).
1843 \begin_layout Description
1847 \begin_layout Subsection*
1850 \begin_layout Description
1851 Action Toggles Sans Serif family font (selection-wise).
1853 \begin_layout Description
1857 \begin_layout Subsection*
1860 \begin_layout Description
1861 Action Toggles Fraktur family font (math-mode, selection-wise).
1863 \begin_layout Description
1866 \begin_layout Description
1867 Origin vermeer, 10 Jan 2002
1870 \begin_layout Subsection*
1873 \begin_layout Description
1874 Action Toggles Italics font shape (math-mode, selection-wise).
1876 \begin_layout Description
1879 \begin_layout Description
1880 Origin vermeer, 10 Jan 2002
1883 \begin_layout Subsection*
1886 \begin_layout Description
1887 Action Reverts the settings of the font to the default values (selection-wise).
1889 \begin_layout Description
1893 \begin_layout Subsection*
1896 \begin_layout Description
1897 Action Sets font size according to lyx format string.
1899 \begin_layout Description
1900 Syntax font-size <SIZE>
1902 \begin_layout Description
1903 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1904 \begin_inset Newline newline
1907 largest|huge|giant|increase|decrease|default
1910 \begin_layout Subsection*
1911 LFUN_TEXTSTYLE_APPLY
1913 \begin_layout Description
1914 Action Toggle user-defined (=last-time used) text style.
1916 \begin_layout Description
1917 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically trigerred when using Text Style dialog.
1919 \begin_layout Description
1920 Syntax textstyle-apply
1922 \begin_layout Description
1923 Origin leeming, 12 Mar 2003
1926 \begin_layout Subsection*
1927 LFUN_TEXTSTYLE_UPDATE
1929 \begin_layout Description
1930 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APPLY.
1932 \begin_layout Description
1933 Syntax textstyle-update <FONT_INFO>
1935 \begin_layout Description
1936 Params <FONT_INFO>: specifies font atributes, e.g. family, series, shape, size, emph, noun, underbar, number, color, language, toggleall.
1937 \begin_inset Newline newline
1940 Use lyx -dbg action for exact syntax of text-style dialog parameters.
1942 \begin_layout Description
1943 Origin leeming, 12 Mar 2003
1946 \begin_layout Subsection*
1947 LFUN_SCREEN_FONT_UPDATE
1949 \begin_layout Description
1950 Action Update fonts and its metrics.
1952 \begin_layout Description
1953 Notion Automatically called after zoom, dpi, font names, or norm change.
1955 \begin_layout Description
1956 Syntax screen-font-update
1958 \begin_layout Description
1959 Origin ARRae, 13 Aug 2000
1962 \begin_layout Subsection*
1965 \begin_layout Description
1966 Action Returns the info about the current font.
1968 \begin_layout Description
1972 \begin_layout Subsection*
1973 LFUN_CITATION_INSERT
1975 \begin_layout Description
1976 Action Inserts citation from loaded citation database.
1978 \begin_layout Description
1979 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
1981 \begin_layout Description
1982 Params <KEY>: Citation (shortcut listed in available citations).
1983 \begin_inset Newline newline
1986 <TEXT_BEFORE>: text which should appear before citation.
1988 \begin_layout Description
1989 Origin AAS, 97-02-23
1992 \begin_layout Subsection*
1993 LFUN_BIBTEX_DATABASE_ADD
1995 \begin_layout Description
1996 Action Adds database, which will be used for bibtex citations.
1998 \begin_layout Description
1999 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2001 \begin_layout Description
2002 Syntax bibtex-database-add <DATABASE-NAME>
2004 \begin_layout Description
2005 Origin Ale, 30 May 1997
2008 \begin_layout Subsection*
2009 LFUN_BIBTEX_DATABASE_DEL
2011 \begin_layout Description
2012 Action Adds database, which will be used for bibtex citations.
2014 \begin_layout Description
2015 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
2017 \begin_layout Description
2018 Syntax bibtex-database-del <DATABASE-NAME>
2020 \begin_layout Description
2021 Origin Ale, 30 May 1997
2024 \begin_layout Subsection*
2027 \begin_layout Description
2028 Action Sets the layout (that is, environment) for the current paragraph.
2030 \begin_layout Description
2031 Syntax layout <LAYOUT>
2033 \begin_layout Description
2034 Params <LAYOUT>: the layout to use
2037 \begin_layout Subsection*
2038 LFUN_LAYOUT_PARAGRAPH
2040 \begin_layout Description
2041 Action Launches the paragraph settings dialog.
2043 \begin_layout Description
2044 Syntax layout-paragraph
2047 \begin_layout Subsection*
2050 \begin_layout Description
2051 Action Launches the tabular settings dialog.
2053 \begin_layout Description
2054 Syntax layout-tabular
2056 \begin_layout Description
2057 Origin Jug, 31 Jul 2000
2060 \begin_layout Subsection*
2061 LFUN_DROP_LAYOUTS_CHOICE
2063 \begin_layout Description
2064 Action Displays list of layout choices.
2066 \begin_layout Description
2067 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox allowing for choice of layout.
2069 \begin_layout Description
2070 Syntax drop-layouts-choice
2073 \begin_layout Subsection*
2074 LFUN_LAYOUT_MODULES_CLEAR
2076 \begin_layout Description
2077 Action Clears the module list.
2079 \begin_layout Description
2080 Notion Clears the list of included modules for the current buffer.
2082 \begin_layout Description
2083 Syntax layout-modules-clear
2085 \begin_layout Description
2086 Origin rgh, 25 August 2007
2089 \begin_layout Subsection*
2090 LFUN_LAYOUT_MODULE_ADD
2092 \begin_layout Description
2093 Action Adds a module.
2095 \begin_layout Description
2096 Notion Adds a module to the list of included modules for the current buffer.
2098 \begin_layout Description
2099 Syntax layout-module-add <MODULE>
2101 \begin_layout Description
2102 Params <MODULE>: the module to be added
2104 \begin_layout Description
2105 Origin rgh, 25 August 2007
2108 \begin_layout Subsection*
2111 \begin_layout Description
2112 Action Reloads layout information.
2114 \begin_layout Description
2115 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.
2117 \begin_layout Description
2118 Syntax layout-reload
2120 \begin_layout Description
2121 Origin rgh, 3 September 2007
2124 \begin_layout Subsection*
2125 LFUN_TEXTCLASS_APPLY
2127 \begin_layout Description
2128 Action Sets the text class for the current buffer.
2130 \begin_layout Description
2131 Syntax textclass-apply <TEXTCLASS>
2133 \begin_layout Description
2134 Params <TEXTCLASS>: the textclass to set. Note that this must be the filename, minus the ".layout" extension.
2137 \begin_layout Subsection*
2140 \begin_layout Description
2141 Action Loads information for a textclass from disk.
2143 \begin_layout Description
2144 Syntax textclass-load <TEXTCLASS>
2146 \begin_layout Description
2147 Params <TEXTCLASS>: the textclass to load. Note that this must be the filename, minus the ".layout" extension.
2150 \begin_layout Subsection*
2153 \begin_layout Description
2154 Action Disable selecting of text-region.
2156 \begin_layout Description
2160 \begin_layout Subsection*
2163 \begin_layout Description
2164 Action Enable selecting of text-region.
2166 \begin_layout Description
2167 Notion After enabling you can simply move arrow keys to get selected region.
2169 \begin_layout Description
2173 \begin_layout Subsection*
2176 \begin_layout Description
2177 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2179 \begin_layout Description
2182 \begin_layout Description
2183 Origin Andre, May 5 2006
2186 \begin_layout Subsection*
2189 \begin_layout Description
2190 Action Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
2192 \begin_layout Description
2193 Syntax math-delim [<LEFT>] [<RIGHT>]
2195 \begin_layout Description
2196 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.
2198 \begin_layout Description
2199 Sample math-delim { rangle
2201 \begin_layout Description
2202 Origin Alejandro, 18 Jun 1996
2205 \begin_layout Subsection*
2208 \begin_layout Description
2209 Action Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
2211 \begin_layout Description
2212 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2214 \begin_layout Description
2215 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2216 \begin_inset Newline newline
2219 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
2221 \begin_layout Description
2222 Sample math-bigdelim "Bigl" "
2228 \begin_layout Description
2229 Origin Enrico & Georg, 7 May 2006
2232 \begin_layout Subsection*
2235 \begin_layout Description
2236 Action Creates a new displayed equation in text mode. Toggles inlined/display formula in math mode.
2238 \begin_layout Description
2239 Syntax math-display [<ARG>]
2241 \begin_layout Description
2242 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating new equation from the text mode.
2244 \begin_layout Description
2245 Origin Alejandro, 18 Jun 1996
2248 \begin_layout Subsection*
2251 \begin_layout Description
2252 Action Inserts math objects and symbols.
2254 \begin_layout Description
2255 Notion When <ARG> is a _single_ math inset with more than one cell (such as "x_y^z" or "
2257 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
2259 frac{x}{y}" replaces "abc" with "
2261 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.
2263 \begin_layout Description
2264 Syntax math-insert <ARG>
2266 \begin_layout Description
2267 Params <ARG>: Symbol or LaTeX code to be inserted.
2270 \begin_layout Subsection*
2273 \begin_layout Description
2274 Action Enters subscript expression in math expression.
2276 \begin_layout Description
2277 Syntax math-subscript
2279 \begin_layout Description
2280 Origin vermeer, 12 Dec 2001
2283 \begin_layout Subsection*
2284 LFUN_MATH_SUPERSCRIPT
2286 \begin_layout Description
2287 Action Enters subscript expression in math expression.
2289 \begin_layout Description
2290 Syntax math-superscript
2292 \begin_layout Description
2293 Origin vermeer, 12 Dec 2001
2296 \begin_layout Subsection*
2299 \begin_layout Description
2300 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.
2302 \begin_layout Description
2303 Notion Put the cursor before the symbol with the limits and then invoke math-limits.
2305 \begin_layout Description
2306 Syntax math-limits [<STATE>]
2308 \begin_layout Description
2309 Params <STATE>: limits|nolimits
2312 \begin_layout Subsection*
2315 \begin_layout Description
2316 Action Inserts a math macro definition at the cursor position in the text.
2318 \begin_layout Description
2319 Syntax math-macro <NAME> [<NARGS>] [def]
2321 \begin_layout Description
2322 Params <NAME>: The name of the macro, e.g. "mymacro".
2323 \begin_inset Newline newline
2326 <NARGS>: The number of parameters of the macro. Default is 0. "def": Has no effect anymore, just for compatibility with former LyX versions.
2328 \begin_layout Description
2329 Origin ale, 10 May 1997; sts, 21 Dec 2007
2332 \begin_layout Subsection*
2335 \begin_layout Description
2336 Action Mutates the type of math inset to the newly selected one.
2338 \begin_layout Description
2339 Syntax math-mutate <TYPE>
2341 \begin_layout Description
2342 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat| multline|gather|flalign
2344 \begin_layout Description
2345 Origin Andre, 23 May 2001
2348 \begin_layout Subsection*
2351 \begin_layout Description
2352 Action Inserts space into math expression.
2354 \begin_layout Description
2355 Notion Use spacebar after entering this space to change type of space.
2357 \begin_layout Description
2358 Syntax math-space [<TYPE>] [<LEN>]
2360 \begin_layout Description
2361 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2362 \begin_inset Newline newline
2365 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2366 \begin_inset Newline newline
2369 custom space: hspace
2370 \begin_inset Newline newline
2373 "," used by default.
2374 \begin_inset Newline newline
2377 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace, and ; = thickspace.
2378 \begin_inset Newline newline
2381 <LEN>: length for custom spaces (hspace)
2383 \begin_layout Description
2384 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2387 \begin_layout Subsection*
2390 \begin_layout Description
2391 Action Inserts a matrix.
2393 \begin_layout Description
2394 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
2396 \begin_layout Description
2397 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).
2399 \begin_layout Description
2400 Sample math-matrix 3 3 bccc
2403 \begin_layout Subsection*
2404 LFUN_MATH_AMS_MATRIX
2406 \begin_layout Description
2407 Action Inserts a matrix.
2409 \begin_layout Description
2410 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
2412 \begin_layout Description
2413 Params <DECORATION>: Decoration determines the LaTeX name of the matrix that should be created.
2415 \begin_layout Description
2416 Sample math-ams-matrix 3 3 bmatrix
2419 \begin_layout Subsection*
2422 \begin_layout Description
2423 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.
2425 \begin_layout Description
2426 Notion If there is some selected text, it puts the text inside created math box.
2428 \begin_layout Description
2429 Syntax math-mode [on|<ARG>]
2431 \begin_layout Description
2432 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT .
2433 \begin_inset Newline newline
2436 "on": allow only entering of math mode from text mode.
2438 \begin_layout Description
2439 Origin Alejandro, 4 Jun 1996
2442 \begin_layout Subsection*
2445 \begin_layout Description
2446 Action Enters regexp mode (i.e., puts regexp insets on the current cursor position). Used by the advanced search dialog.
2448 \begin_layout Description
2449 Notion If there is any selected text, then it is moved inside the created regexp inset.
2451 \begin_layout Description
2452 Syntax regexp-mode [<ARG>]
2454 \begin_layout Description
2455 Params <ARG>: eventual argument (regular expression).
2457 \begin_layout Description
2458 Origin Tommaso, 4 Oct 2008
2461 \begin_layout Subsection*
2462 LFUN_MATH_NUMBER_LINE_TOGGLE
2464 \begin_layout Description
2465 Action Toggles numbering of the current formula line.
2467 \begin_layout Description
2468 Notion Must be in display formula mode.
2470 \begin_layout Description
2471 Syntax math-number-line-toggle
2473 \begin_layout Description
2474 Origin Alejandro, 18 Jun 1996
2477 \begin_layout Subsection*
2478 LFUN_MATH_NUMBER_TOGGLE
2480 \begin_layout Description
2481 Action Toggles numbering/labeling of the current formula.
2483 \begin_layout Description
2484 Notion Must be in display formula mode.
2486 \begin_layout Description
2487 Syntax math-number-toggle
2489 \begin_layout Description
2490 Origin Alejandro, 4 Jun 1996
2493 \begin_layout Subsection*
2496 \begin_layout Description
2497 Action Calls external program and passes the current expression/equation as an argument for the calculation in the format appropriate to the given language.
2499 \begin_layout Description
2500 Notion Selection can be used to determine the input for the external program.
2502 \begin_layout Description
2503 Syntax math-extern <LANG> [<COMMAND>]
2505 \begin_layout Description
2506 Params <LANG>: octave|maxima|maple|mathematica|script
2507 \begin_inset Newline newline
2510 where "script" stands fot the external script (normalized expression will be passed)
2512 \begin_layout Description
2513 Sample math-extern maple simplify
2515 \begin_layout Description
2516 Origin Andre, 24 Apr 2001
2519 \begin_layout Subsection*
2522 \begin_layout Description
2523 Action Changes arbitrarily the size used by math fonts inside a context.
2525 \begin_layout Description
2526 Notion Provides an interface to the LaTeX math mode font size commands.
2528 \begin_layout Description
2529 Syntax math-size <STYLE>
2531 \begin_layout Description
2542 \begin_layout Description
2543 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
2546 \begin_layout Subsection*
2547 LFUN_MATH_FONT_STYLE
2549 \begin_layout Description
2550 Action Changes the text style used in math.
2552 \begin_layout Description
2553 Syntax math-font-style <STYLE>
2555 \begin_layout Description
2556 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|textrm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
2558 \begin_layout Description
2559 Origin vfr, 9 jan 2009
2562 \begin_layout Subsection*
2563 LFUN_MATH_MACRO_UNFOLD
2565 \begin_layout Description
2566 Action Unfold a Math Macro.
2568 \begin_layout Description
2569 Notion Unfold the Math Macro the cursor is in, i.e. display it as
2573 \begin_layout Description
2574 Syntax math-macro-unfold
2576 \begin_layout Description
2577 Origin sts, 06 January 2008
2580 \begin_layout Subsection*
2581 LFUN_MATH_MACRO_FOLD
2583 \begin_layout Description
2584 Action Fold a Math Macro.
2586 \begin_layout Description
2587 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e. displayed as
2591 \begin_layout Description
2592 Syntax math-macro-fold
2594 \begin_layout Description
2595 Origin sts, 06 January 2008
2598 \begin_layout Subsection*
2599 LFUN_MATH_MACRO_ADD_PARAM
2601 \begin_layout Description
2602 Action Add a parameter.
2604 \begin_layout Description
2605 Notion Add a parameter to a Math Macro.
2607 \begin_layout Description
2608 Syntax math-macro-add-param <NUM>
2610 \begin_layout Description
2611 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.
2613 \begin_layout Description
2614 Origin sts, 06 January 2008
2617 \begin_layout Subsection*
2618 LFUN_MATH_MACRO_REMOVE_PARAM
2620 \begin_layout Description
2621 Action Remove the last parameter.
2623 \begin_layout Description
2624 Notion Remove the last parameter of a Math Macro and remove its value in all instances of the macro in the buffer.
2626 \begin_layout Description
2627 Syntax math-macro-remove-param <NUM>
2629 \begin_layout Description
2630 Params <NUM>: The number of the parameter to be deleted (1 for the first), defaults to the last one.
2632 \begin_layout Description
2633 Origin sts, 06 January 2008
2636 \begin_layout Subsection*
2637 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
2639 \begin_layout Description
2640 Action Append a greedy parameter.
2642 \begin_layout Description
2643 Notion Append a greedy parameter to a Math Macro which eats the following mathed cell in every instance of the macro in the buffer.
2645 \begin_layout Description
2646 Syntax math-macro-append-greedy-param
2648 \begin_layout Description
2649 Origin sts, 06 January 2008
2652 \begin_layout Subsection*
2653 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
2655 \begin_layout Description
2656 Action Remove a greedy parameter.
2658 \begin_layout Description
2659 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.
2661 \begin_layout Description
2662 Syntax math-macro-remove-greedy-param
2664 \begin_layout Description
2665 Origin sts, 06 January 2008
2668 \begin_layout Subsection*
2669 LFUN_MATH_MACRO_MAKE_OPTIONAL
2671 \begin_layout Description
2672 Action Make a parameter optional.
2674 \begin_layout Description
2675 Notion Turn the first non-optional parameter of a Math Macro into an optional parameter with a default value.
2677 \begin_layout Description
2678 Syntax math-macro-make-optional
2680 \begin_layout Description
2681 Origin sts, 06 January 2008
2684 \begin_layout Subsection*
2685 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
2687 \begin_layout Description
2688 Action Make a parameter non-optional.
2690 \begin_layout Description
2691 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.
2693 \begin_layout Description
2694 Syntax math-macro-make-nonoptional
2696 \begin_layout Description
2697 Origin sts, 06 January 2008
2700 \begin_layout Subsection*
2701 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
2703 \begin_layout Description
2704 Action Add an optional parameter.
2706 \begin_layout Description
2707 Notion Insert an optional parameter just behind the already existing optional parameters.
2709 \begin_layout Description
2710 Syntax math-macro-add-optional-param
2712 \begin_layout Description
2713 Origin sts, 06 January 2008
2716 \begin_layout Subsection*
2717 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
2719 \begin_layout Description
2720 Action Remove the last optional parameter.
2722 \begin_layout Description
2723 Notion Remove the last optional parameter of a Math Macro and remove it in all the instances of the macro in the buffer.
2725 \begin_layout Description
2726 Syntax math-macro-remove-optional-param
2728 \begin_layout Description
2729 Origin sts, 06 January 2008
2732 \begin_layout Subsection*
2733 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
2735 \begin_layout Description
2736 Action Add a greedy optional parameter.
2738 \begin_layout Description
2739 Notion Add a greedy optional parameter which eats the value from the following cells in mathed which are in the [value] format.
2741 \begin_layout Description
2742 Syntax math-macro-add-greedy-optional-param
2744 \begin_layout Description
2745 Origin sts, 06 January 2008
2748 \begin_layout Subsection*
2749 LFUN_IN_MATHMACROTEMPLATE
2751 \begin_layout Description
2752 Action Only active in Math Macro definition.
2754 \begin_layout Description
2755 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.
2757 \begin_layout Description
2758 Syntax in-mathmacrotemplate
2760 \begin_layout Description
2761 Origin sts, 06 January 2008
2764 \begin_layout Subsection*
2765 LFUN_PARAGRAPH_MOVE_DOWN
2767 \begin_layout Description
2768 Action Moves the current paragraph downwards in the document.
2770 \begin_layout Description
2771 Syntax paragraph-move-down
2773 \begin_layout Description
2774 Origin Edwin, 8 Apr 2006
2777 \begin_layout Subsection*
2778 LFUN_PARAGRAPH_MOVE_UP
2780 \begin_layout Description
2781 Action Moves the current paragraph upwards in the document.
2783 \begin_layout Description
2784 Syntax paragraph-move-up
2786 \begin_layout Description
2787 Origin Edwin, 8 Apr 2006
2790 \begin_layout Subsection*
2793 \begin_layout Description
2794 Action Move the cursor to the next paragraph (or begining of the current one) in upward direction.
2796 \begin_layout Description
2799 \begin_layout Description
2800 Origin Asger, 1 Oct 1996
2803 \begin_layout Subsection*
2804 LFUN_PARAGRAPH_UP_SELECT
2806 \begin_layout Description
2807 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in upward direction.
2809 \begin_layout Description
2810 Syntax paragraph-up-select
2812 \begin_layout Description
2813 Origin Asger, 1 Oct 1996
2816 \begin_layout Subsection*
2819 \begin_layout Description
2820 Action Move the cursor to the next paragraph (or begining of the current one) in downward direction.
2822 \begin_layout Description
2823 Syntax paragraph-down
2825 \begin_layout Description
2826 Origin Asger, 1 Oct 1996
2829 \begin_layout Subsection*
2830 LFUN_PARAGRAPH_DOWN_SELECT
2832 \begin_layout Description
2833 Action Move the cursor and select the text to the next paragraph (or begining of the current one) in downward direction.
2835 \begin_layout Description
2836 Syntax paragraph-down-select
2838 \begin_layout Description
2839 Origin Asger, 1 Oct 1996
2842 \begin_layout Subsection*
2845 \begin_layout Description
2846 Action Jump to a paragraph given by its id number and optionally the desired position within the paragraph.
2848 \begin_layout Description
2849 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).
2851 \begin_layout Description
2852 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
2854 \begin_layout Description
2855 Params <PAR_ID_NUMBER>: paragraph id
2856 \begin_inset Newline newline
2859 <POSITION_IN_PAR>: desired position within the paragraph
2861 \begin_layout Description
2862 Origin Dekel, 26 Aug 2000
2865 \begin_layout Subsection*
2866 LFUN_BREAK_PARAGRAPH
2868 \begin_layout Description
2869 Action Breaks the current paragraph at the current location.
2871 \begin_layout Description
2872 Notion Removes the selection.
2874 \begin_layout Description
2875 Syntax break-paragraph [<LAYOUT>]
2877 \begin_layout Description
2878 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to default layout) when the cursor is at the end of the line.
2881 \begin_layout Subsection*
2882 LFUN_PARAGRAPH_PARAMS
2884 \begin_layout Description
2885 Action Change paragraph settings.
2887 \begin_layout Description
2888 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.
2890 \begin_layout Description
2891 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
2893 \begin_layout Description
2903 \begin_inset Newline newline
2908 paragraph_spacing default|single|onehalf|double|other SIZE
2909 \begin_inset Newline newline
2914 align block|left|right|center|default
2915 \begin_inset Newline newline
2920 labelwidthstring WIDTH|
2924 \begin_layout Description
2925 Origin rgh, Aug 15 2007
2928 \begin_layout Subsection*
2929 LFUN_PARAGRAPH_PARAMS_APPLY
2931 \begin_layout Description
2932 Action Change paragraph settings.
2934 \begin_layout Description
2935 Notion Overwrite all nonspecified settings to the default ones. Use paragraph-params lfun if you don't want to overwrite others settings.
2937 \begin_layout Description
2938 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2940 \begin_layout Description
2941 Params For parameters see LFUN_PARAGRAPH_PARAMS
2943 \begin_layout Description
2944 Origin leeming, 30 Mar 2004
2947 \begin_layout Subsection*
2948 LFUN_PARAGRAPH_UPDATE
2950 \begin_layout Description
2951 Action Updates the values inside the paragraph dialog from the paragraph.
2953 \begin_layout Description
2954 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE.
2956 \begin_layout Description
2957 Origin leeming, 13 Mar 2003
2960 \begin_layout Subsection*
2963 \begin_layout Description
2964 Action Move the current group in the upward direction in the structure of the document.
2966 \begin_layout Description
2967 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2969 \begin_layout Description
2972 \begin_layout Description
2973 Origin Vermeer, 23 Mar 2006
2976 \begin_layout Subsection*
2979 \begin_layout Description
2980 Action Move the current group in the downward direction in the structure of the document.
2982 \begin_layout Description
2983 Notion The "group" can be Part/Chapter/Section/etc. It moves the whole substructure of the group.
2985 \begin_layout Description
2988 \begin_layout Description
2989 Origin Vermeer, 23 Mar 2006
2992 \begin_layout Subsection*
2995 \begin_layout Description
2996 Action Moves the current group in the downward direction in the hierarchy of the document structure.
2998 \begin_layout Description
2999 Notion Part -> Chapter -> Section -> etc.
3001 \begin_layout Description
3004 \begin_layout Description
3005 Origin Vermeer, 23 Mar 2006
3008 \begin_layout Subsection*
3011 \begin_layout Description
3012 Action Moves the current group in the upward direction in the hierarchy of the document structure.
3014 \begin_layout Description
3015 Notion Part <- Chapter <- Section <- etc.
3017 \begin_layout Description
3020 \begin_layout Description
3021 Origin Vermeer, 23 Mar 2006
3024 \begin_layout Subsection*
3027 \begin_layout Description
3028 Action Edit the inset at cursor with an external application, if one is attributed.
3030 \begin_layout Description
3031 Syntax inset-edit [<INSET_PARAMS>]
3033 \begin_layout Description
3034 Params <INSET_PARAMS>: Parameters for the inset.
3035 \begin_inset Newline newline
3038 Currently only the filename will be considered.
3040 \begin_layout Description
3041 Origin JSpitzm, 27 Apr 2006
3044 \begin_layout Subsection*
3047 \begin_layout Description
3048 Action Inserts table into the document.
3050 \begin_layout Description
3051 Syntax tabular-insert [<ROWS> <COLUMNS>]
3053 \begin_layout Description
3054 Params In case no arguments are given show insert dialog.
3056 \begin_layout Description
3057 Origin Jug, 12 Apr 2000
3060 \begin_layout Subsection*
3061 LFUN_TABULAR_FEATURE
3063 \begin_layout Description
3064 Action Sets various features to the table/cell on the current cursor position.
3066 \begin_layout Description
3067 Notion Various math-environment features are handled here as well, e.g. add-vline-left/right for the Grid/Array environment
3069 \begin_layout Description
3070 Syntax tabular-feature <FEATURE> [<ARG>]
3072 \begin_layout Description
3073 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-multicolumn|set-special-multirow| 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
3074 \begin_inset Newline newline
3077 <ARG>: additional argument for some commands, use debug mode to explore its values.
3079 \begin_layout Description
3080 Origin Jug, 28 Jul 2000
3083 \begin_layout Subsection*
3086 \begin_layout Description
3087 Action Moves the cursor to the previous cell inside the table.
3089 \begin_layout Description
3090 Syntax cell-backward
3092 \begin_layout Description
3093 Origin Jug, 22 May 2000
3096 \begin_layout Subsection*
3099 \begin_layout Description
3100 Action Moves the cursor to the next cell inside the table.
3102 \begin_layout Description
3106 \begin_layout Subsection*
3109 \begin_layout Description
3110 Action Splits cell and shifts right part to the next cell (inside the math grid).
3112 \begin_layout Description
3115 \begin_layout Description
3116 Origin Ale, 15 May 1997
3119 \begin_layout Subsection*
3122 \begin_layout Description
3123 Action Register the document as an file inside version control system (RCS, CVS).
3125 \begin_layout Description
3126 Notion File is registered inside cvs, svn or rcs repository acording to the existence of cvs/svn/rcs entries in the document's directory.
3127 \begin_inset Newline newline
3130 See LyX Additional Features Manual (Version Control Chapter) for additional information.
3132 \begin_layout Description
3135 \begin_layout Description
3136 Origin Lgb, 1 Jul 1997
3139 \begin_layout Subsection*
3142 \begin_layout Description
3143 Action Checks-in/commits the changes of the registered file to the repository.
3145 \begin_layout Description
3146 Notion In RCS case this also unlocks the file.
3148 \begin_layout Description
3151 \begin_layout Description
3152 Origin Lgb, 1 Jul 1997
3155 \begin_layout Subsection*
3158 \begin_layout Description
3159 Action Checks-out the document for edit (and locks it for RCS).
3161 \begin_layout Description
3162 Notion This is implemented only for RCS and SVN, not CVS.
3164 \begin_layout Description
3167 \begin_layout Description
3168 Origin Lgb, 1 Jul 1997
3171 \begin_layout Subsection*
3174 \begin_layout Description
3175 Action Reverts the document to the last check-in/commit in VCS.
3177 \begin_layout Description
3180 \begin_layout Description
3181 Origin Lgb, 1 Jul 1997
3184 \begin_layout Subsection*
3187 \begin_layout Description
3188 Action Undo last check-in.
3190 \begin_layout Description
3191 Notion This is currently implemented only for RCS.
3193 \begin_layout Description
3196 \begin_layout Description
3197 Origin Lgb, 1 Jul 1997
3200 \begin_layout Subsection*
3203 \begin_layout Description
3204 Action Executes external command. This command is intended to support additional VCS commands.
3206 \begin_layout Description
3207 Syntax vc-command <FLAG> <PATH> <COMMAND>
3209 \begin_layout Description
3210 Params <FLAG>: Flags for the command can be combined together.
3211 \begin_inset Newline newline
3214 U - dUmmy - no flags
3215 \begin_inset Newline newline
3218 D - Doc - need document loaded to proceed
3219 \begin_inset Newline newline
3222 I - dIrty - mark document dirty
3223 \begin_inset Newline newline
3226 R - Reload - ensure that the document is saved and reload it after command execution
3227 \begin_inset Newline newline
3230 M - Message - ask for input string (commit message)
3231 \begin_inset Newline newline
3234 <PATH>: path where to start. $$p will be replaced by the current document path.
3235 \begin_inset Newline newline
3238 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document(with absolute path)/path/message.
3240 \begin_layout Description
3241 Sample vc-command DR $$p "svn up"
3243 \begin_layout Description
3244 Origin sanda, 13 Jan 2009
3247 \begin_layout Subsection*
3248 LFUN_VC_LOCKING_TOGGLE
3250 \begin_layout Description
3251 Action Toggles the locking property of the edited file.
3253 \begin_layout Description
3254 Notion This is currently implemented only for SVN.
3256 \begin_layout Description
3257 Syntax vc-locking-toggle
3259 \begin_layout Description
3260 Origin sanda, 25 Jun 2009
3263 \begin_layout Subsection*
3266 \begin_layout Description
3267 Action Update the local archive directory in which resides the current document with the remote repository.
3269 \begin_layout Description
3270 Notion This is currently implemented only for SVN.
3272 \begin_layout Description
3273 Syntax vc-repo-update
3275 \begin_layout Description
3276 Origin sanda, 16 Oct 2009
3279 \begin_layout Subsection*
3282 \begin_layout Description
3283 Action Toggles change tracking to on/off.
3285 \begin_layout Description
3286 Syntax changes-track
3288 \begin_layout Description
3289 Origin levon, 1 Oct 2002
3292 \begin_layout Subsection*
3295 \begin_layout Description
3296 Action Toggles showing of change tracking in typesetted output.
3298 \begin_layout Description
3299 Syntax changes-output
3301 \begin_layout Description
3302 Origin jspitzm, 21 Jan 2005
3305 \begin_layout Subsection*
3308 \begin_layout Description
3309 Action Moves the cursor to the position of the next change of the change tracking records.
3311 \begin_layout Description
3314 \begin_layout Description
3315 Origin schmitt, 4 Oct 2006
3318 \begin_layout Subsection*
3319 LFUN_CHANGE_PREVIOUS
3321 \begin_layout Description
3322 Action Moves the cursor to the position of the previous change of the change tracking records.
3324 \begin_layout Description
3325 Syntax change-previous
3327 \begin_layout Description
3328 Origin vfr, 4 Apr 2009
3331 \begin_layout Subsection*
3334 \begin_layout Description
3335 Action Open change tracking dialog for merging and moves the cursor to the position of the next change.
3337 \begin_layout Description
3338 Syntax changes-merge
3340 \begin_layout Description
3341 Origin Levon, 16 Oct 2002
3344 \begin_layout Subsection*
3347 \begin_layout Description
3348 Action Accepts tracked change inside the selection.
3350 \begin_layout Description
3351 Syntax change-accept
3353 \begin_layout Description
3354 Origin Levon, 16 Oct 2002
3357 \begin_layout Subsection*
3360 \begin_layout Description
3361 Action Rejects tracked change inside the selection.
3363 \begin_layout Description
3364 Syntax change-accept
3366 \begin_layout Description
3367 Origin Levon, 16 Oct 2002
3370 \begin_layout Subsection*
3371 LFUN_ALL_CHANGES_ACCEPT
3373 \begin_layout Description
3374 Action Accepts all tracked changes in the document.
3376 \begin_layout Description
3377 Syntax all-changes-accept
3379 \begin_layout Description
3380 Origin Levon, 16 Oct 2002
3383 \begin_layout Subsection*
3384 LFUN_ALL_CHANGES_REJECT
3386 \begin_layout Description
3387 Action Rejects all tracked changes in the document.
3389 \begin_layout Description
3390 Notion Reject does not work recursively; the user may have to repeat the operation.
3392 \begin_layout Description
3393 Syntax all-changes-reject
3395 \begin_layout Description
3396 Origin Levon, 16 Oct 2002
3399 \begin_layout Subsection*
3402 \begin_layout Description
3403 Action Apply data for an inset.
3405 \begin_layout Description
3406 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.
3408 \begin_layout Description
3409 Syntax inset-apply <ARGS>
3411 \begin_layout Description
3412 Params See LFUN_INSET_INSERT .
3415 \begin_layout Subsection*
3418 \begin_layout Description
3419 Action Dissolve the current inset into text.
3421 \begin_layout Description
3422 Syntax inset-dissolve [<INSET>]
3424 \begin_layout Description
3425 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.
3426 \begin_inset Newline newline
3429 For values see lyx::InsetLayout::lyxtype_ .
3431 \begin_layout Description
3432 Origin JSpitz, 7 Aug 2006
3435 \begin_layout Subsection*
3438 \begin_layout Description
3439 Action Insert new inset (type given by the parameters).
3441 \begin_layout Description
3442 Syntax inset-insert <INSET> <ARGS>
3444 \begin_layout Description
3445 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|include|index|label|nomencl|vspace|ref|toc>
3446 \begin_inset Newline newline
3449 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
3451 \begin_layout Description
3452 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
3455 \begin_inset Newline newline
3458 where <label name> is the name of the referenced label and <Format> is one of the following:
3459 \begin_inset Newline newline
3463 \begin_inset Newline newline
3466 eqref -- (<reference>)
3467 \begin_inset Newline newline
3471 \begin_inset Newline newline
3474 vpageref -- on <page>
3475 \begin_inset Newline newline
3478 vref -- <reference> on <page>
3479 \begin_inset Newline newline
3482 prettyref -- Formatted reference
3485 \begin_layout Subsection*
3488 \begin_layout Description
3489 Action Modify some properties of an inset.
3491 \begin_layout Description
3492 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats, graphics, include, index, info, label, listings, newline, newpage, nomencl, note, phantom, ref, space, tabular, vspace, wrap insets.
3494 \begin_layout Description
3495 Syntax inset-modify <INSET> <ARGS>inset-modify changetype <TYPE>
3497 \begin_layout Description
3498 Params See LFUN_INSET_INSERT for further details.
3500 \begin_layout Description
3501 Sample inset-modify note Note Commentinset-modify changetype Ovalbox
3504 \begin_layout Subsection*
3505 LFUN_INSET_DIALOG_UPDATE
3507 \begin_layout Description
3508 Action Updates the values inside the dialog from the inset.
3510 \begin_layout Description
3511 Notion This is internal LFUN, not to be used by users. Called internally by LFUN_DIALOG_UPDATE
3513 \begin_layout Description
3514 Params <DIALOG-NAME>
3516 \begin_layout Description
3517 Origin leeming, 25 Feb 2003
3520 \begin_layout Subsection*
3523 \begin_layout Description
3524 Action Open the inset's properties dialog.
3526 \begin_layout Description
3527 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.
3529 \begin_layout Description
3530 Syntax inset-settings <INSET>
3532 \begin_layout Description
3533 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>.
3536 \begin_layout Subsection*
3539 \begin_layout Description
3540 Action Toggles the collapsable inset at cursor position, or the inset we are currently in.
3542 \begin_layout Description
3543 Syntax inset-toggle [<ARG>]
3545 \begin_layout Description
3546 Params <ARG>: <open|close|toggle|assign>.
3547 \begin_inset Newline newline
3550 open/close/toggle are for collapsable insets. toggle is used when no argument is given.
3551 \begin_inset Newline newline
3554 assign synchronize the branch-inset with activation status of the branch. Used for global toggling when changed activation.
3556 \begin_layout Description
3557 Origin lasgouttes, 19 Jul 2001
3560 \begin_layout Subsection*
3561 LFUN_ALL_INSETS_TOGGLE
3563 \begin_layout Description
3564 Action Toggles (open/closes) all collapsable insets (of a given type) in the document.
3566 \begin_layout Description
3567 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
3569 \begin_layout Description
3570 Syntax all-insets-toggle [<STATE>] [<INSET>]
3572 \begin_layout Description
3573 Params <STATE>: <toggle|open|close|assign> default: toggle
3574 \begin_inset Newline newline
3577 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
3579 \begin_layout Description
3580 Origin leeming, 30 Mar 2004
3583 \begin_layout Subsection*
3586 \begin_layout Description
3587 Action Apply the given commands on insets of a given name.
3589 \begin_layout Description
3590 Notion WARNING: use at your own risks; this function gives you too many ways of shooting yourself in the foot. A typical example is inset-forall Note note-insert which starts an infinite loop. This is mitigated by the fact that the number of actions is arbitrarily limited to 10000.
3592 \begin_layout Description
3593 Syntax inset-forall <NAME> <LFUN-COMMAND>
3594 \begin_inset Newline newline
3597 <NAME>: Type of Inset. If <NAME> is *, all insets are matched. The name is used like for InsetLayout in layout files: "Note" matches all note insets, while "Note:Note" only matches LyX yellow note insets.
3599 \begin_layout Description
3600 Sample Remove all index insets:
3601 \begin_inset Newline newline
3604 inset-forall Index delete-char-forward
3605 \begin_inset Newline newline
3608 Close all Notes (also works for a particular branch, for example):
3609 \begin_inset Newline newline
3612 inset-forall Note inset-toggle close
3613 \begin_inset Newline newline
3616 Transform all yellow notes to comments
3617 \begin_inset Newline newline
3620 inset-forall Note:Note inset-modify note Note Comment
3621 \begin_inset Newline newline
3624 Try to put LyX in an infinite loop if there is at least a Note:
3625 \begin_inset Newline newline
3628 inset-forall Note char-backward
3630 \begin_layout Description
3631 Origin lasgouttes, 27 Nov 2009
3634 \begin_layout Subsection*
3635 LFUN_GRAPHICS_RELOAD
3637 \begin_layout Description
3638 Action Reloads the image if necessary.
3640 \begin_layout Description
3641 Syntax graphics-reload
3643 \begin_layout Description
3644 Origin vfr, 10 Aug 2009
3647 \begin_layout Subsection*
3648 LFUN_SET_GRAPHICS_GROUP
3650 \begin_layout Description
3651 Action Set the group for the graphics inset on the cursor position.
3653 \begin_layout Description
3654 Syntax set-graphics-group [<GROUP>]
3656 \begin_layout Description
3657 Params <GROUP>: Id for an existing group. In case the Id is an empty string, the graphics inset is removed from the current group.
3659 \begin_layout Description
3660 Origin sanda, 6 May 2008
3663 \begin_layout Subsection*
3664 LFUN_FINISHED_FORWARD
3666 \begin_layout Description
3667 Action Moves the cursor out of the current slice, going forward.
3669 \begin_layout Description
3670 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.
3673 \begin_layout Subsection*
3674 LFUN_FINISHED_BACKWARD
3676 \begin_layout Description
3677 Action Moves the cursor out of the current slice, going backwards.
3679 \begin_layout Description
3680 Notion See also LFUN_FINISHED_FORWARD.
3683 \begin_layout Subsection*
3686 \begin_layout Description
3687 Action Moves the cursor out of the current slice, going right.
3689 \begin_layout Description
3690 Notion See also LFUN_FINISHED_FORWARD
3693 \begin_layout Subsection*
3696 \begin_layout Description
3697 Action Moves the cursor out of the current slice, going left.
3699 \begin_layout Description
3700 Notion See also LFUN_FINISHED_FORWARD.
3703 \begin_layout Subsection*
3706 \begin_layout Description
3707 Action Set language from the current cursor position.
3709 \begin_layout Description
3710 Syntax language <LANG>
3712 \begin_layout Description
3713 Params <LANG>: Requested language. Look in lib/languages for the list.
3715 \begin_layout Description
3716 Origin Dekel, 2 Mar 2000
3719 \begin_layout Subsection*
3722 \begin_layout Description
3723 Action Goto a label.
3725 \begin_layout Description
3726 Syntax label-goto [<LABEL>]
3728 \begin_layout Description
3729 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.
3731 \begin_layout Description
3732 Origin Ale, 6 Aug 1997
3735 \begin_layout Subsection*
3738 \begin_layout Description
3739 Action Inserts label to text or displayed formula.
3741 \begin_layout Description
3742 Syntax label-insert [<LABEL>]
3744 \begin_layout Description
3745 Params <LABEL>: Requested label. If no label is given dialog requesting name will be opened.
3748 \begin_layout Subsection*
3751 \begin_layout Description
3752 Action Go to the next label or cross-reference.
3754 \begin_layout Description
3755 Syntax reference-next
3757 \begin_layout Description
3758 Origin Dekel, 14 Jan 2001
3761 \begin_layout Subsection*
3764 \begin_layout Description
3765 Action Moves the cursor to the numbered bookmark, opening the file if necessary. Note that bookmarsk are saved per-session, not per file.
3767 \begin_layout Description
3768 Notion Bookmark 0 has a special purpose. It is automatically set
3769 \begin_inset Newline newline
3772 1. to the paragraph you are currently editing
3773 \begin_inset Newline newline
3776 2. to the paragraph from where you are jumping to the last-edited position (jump-back feature)
3777 \begin_inset Newline newline
3780 3. when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
3782 \begin_layout Description
3783 Syntax bookmark-goto <NUMBER>
3785 \begin_layout Description
3786 Params <NUMBER>: the number of the bookmark to restore.
3788 \begin_layout Description
3789 Origin Dekel, 27 January 2001
3792 \begin_layout Subsection*
3795 \begin_layout Description
3796 Action Save a bookmark.
3798 \begin_layout Description
3799 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.
3801 \begin_layout Description
3802 Syntax bookmark-save <NUMBER>
3804 \begin_layout Description
3805 Params <NUMBER>: the number of the bookmark to save.
3807 \begin_layout Description
3808 Origin Dekel, 27 January 2001
3811 \begin_layout Subsection*
3814 \begin_layout Description
3815 Action Clears the list of saved bookmarks.
3817 \begin_layout Description
3818 Syntax bookmark-clear
3820 \begin_layout Description
3821 Origin bpeng, 31 October 2006
3824 \begin_layout Subsection*
3827 \begin_layout Description
3828 Action Open the given help file according to the language setting.
3830 \begin_layout Description
3831 Syntax help-open <FILE>[.lyx]
3833 \begin_layout Description
3834 Params <FILE>: any document from (/usr/share/)doc directory.
3836 \begin_layout Description
3837 Origin Jug, 27 Jun 1999
3840 \begin_layout Subsection*
3843 \begin_layout Description
3844 Action Terminates the current LyX instance.
3846 \begin_layout Description
3847 Notion Terminates the current LyX instance, asking whether to save modified documents, etc.
3849 \begin_layout Description
3853 \begin_layout Subsection*
3856 \begin_layout Description
3857 Action Toggles visibility of a given toolbar between on/off/auto.
3859 \begin_layout Description
3860 Notion Skipping "auto" when allowauto is false.
3862 \begin_layout Description
3863 Syntax toolbar-toggle <NAME> [allowauto]
3865 \begin_layout Description
3866 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|view/update|math_panels|vcs
3868 \begin_layout Description
3869 Origin Edwin, 21 May 2007
3872 \begin_layout Subsection*
3875 \begin_layout Description
3876 Action Opens the menu given by its name.
3878 \begin_layout Description
3879 Syntax menu-open <NAME>
3881 \begin_layout Description
3882 Params <NAME>: menu name. See various .inc files in lib/ui for candidates.
3885 \begin_layout Subsection*
3888 \begin_layout Description
3889 Action Various UI visibility-toggling actions.
3891 \begin_layout Description
3892 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
3894 \begin_layout Description
3895 Params statusbar : Toggle visibility of the statusbar.
3896 \begin_inset Newline newline
3899 menubar : Toggle visibility of the menubar.
3900 \begin_inset Newline newline
3903 scrollbar : Toggle visibility of the scrollbar.
3904 \begin_inset Newline newline
3907 frame : Toggle visibility of the frames around editing window.
3908 \begin_inset Newline newline
3911 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.
3913 \begin_layout Description
3914 Origin sanda, 9 Feb 2007
3917 \begin_layout Subsection*
3920 \begin_layout Description
3921 Action Creates new empty LyX window.
3923 \begin_layout Description
3924 Notion Already opened documents from the previous window can be found under View menu.
3926 \begin_layout Description
3927 Syntax window-new [<GEOMETRY>]
3929 \begin_layout Description
3930 Params <GEOMETRY>: pass the geometry of the window. This parameter is currently accepted only on Windows platform.
3932 \begin_layout Description
3933 Origin Abdel, 21 Oct 2006
3936 \begin_layout Subsection*
3939 \begin_layout Description
3940 Action Closes the current LyX window.
3942 \begin_layout Description
3945 \begin_layout Description
3946 Origin Abdel, 23 Oct 2006
3949 \begin_layout Subsection*
3952 \begin_layout Description
3953 Action Creates another split view of current buffer.
3955 \begin_layout Description
3956 Notion All split views act in the same way indpendently.
3958 \begin_layout Description
3959 Syntax split-view <vertical|horizontal>
3961 \begin_layout Description
3962 Params horizontal : The work areas are laid out side by side.
3963 \begin_inset Newline newline
3966 vertical : The work areas laid out vertically.
3968 \begin_layout Description
3969 Origin Abdel, 20 Feb 2008
3972 \begin_layout Subsection*
3973 LFUN_CLOSE_TAB_GROUP
3975 \begin_layout Description
3976 Action Close the current tab group.
3978 \begin_layout Description
3979 Notion This only closes the work areas, not the buffer themselves. The still opened buffers can be visualized in another tab group.
3981 \begin_layout Description
3982 Syntax close-tab-group
3984 \begin_layout Description
3985 Origin Abdel, 21 Feb 2008
3988 \begin_layout Subsection*
3991 \begin_layout Description
3992 Action Shows hidden dialog or create new one for a given function/inset settings etc.
3994 \begin_layout Description
3995 Syntax dialog-show <NAME> [<DATA>]
3997 \begin_layout Description
3998 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
3999 \begin_inset Newline newline
4002 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|
4003 \begin_inset Newline newline
4006 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|
4007 \begin_inset Newline newline
4010 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
4011 \begin_inset Newline newline
4014 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
4015 \begin_inset Newline newline
4018 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
4019 \begin_inset Newline newline
4022 <SPECIAL>: latexlog|vclog
4023 \begin_inset Newline newline
4026 <DATA>: data, usually settings for the given dialog. Use debug mode for the details.
4028 \begin_layout Description
4029 Origin leeming, 17 Jun 2003
4032 \begin_layout Subsection*
4033 LFUN_DIALOG_SHOW_NEW_INSET
4035 \begin_layout Description
4036 Action Shows hidden dialog or create new one for a given inset settings etc.
4038 \begin_layout Description
4039 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given inset.
4041 \begin_layout Description
4042 Syntax dialog-show-new-inset <NAME> [<DATA>]
4044 \begin_layout Description
4045 Params See LFUN_DIALOG_SHOW .
4047 \begin_layout Description
4048 Origin leeming, 25 Feb 2003
4051 \begin_layout Subsection*
4054 \begin_layout Description
4055 Action Updates the dialog values from the inset/paragraph/document.
4057 \begin_layout Description
4058 Syntax dialog-update <NAME>
4060 \begin_layout Description
4061 Params <NAME>: paragraph|prefs|<INSET>
4062 \begin_inset Newline newline
4067 \begin_layout Description
4068 Origin leeming, 25 Feb 2003
4071 \begin_layout Subsection*
4074 \begin_layout Description
4075 Action Hides showed dialog. Counterpart to LFUN_DIALOG_SHOW .
4077 \begin_layout Description
4078 Syntax dialog-hide <NAME>
4080 \begin_layout Description
4081 Params See LFUN_DIALOG_SHOW .
4083 \begin_layout Description
4084 Origin leeming, 25 Feb 2003
4087 \begin_layout Subsection*
4090 \begin_layout Description
4091 Action Toggles dialog between showed/hidden state.
4093 \begin_layout Description
4094 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
4096 \begin_layout Description
4097 Syntax dialog-toggle <NAME> [<DATA>]
4099 \begin_layout Description
4100 Params See LFUN_DIALOG_SHOW .
4102 \begin_layout Description
4103 Origin JSpitzm, 30 Apr 2007
4106 \begin_layout Subsection*
4107 LFUN_DIALOG_DISCONNECT_INSET
4109 \begin_layout Description
4110 Action Closes opened connection to opened inset.
4112 \begin_layout Description
4113 Notion Connection is used for apply functions.
4115 \begin_layout Description
4116 Syntax dialog-disconnect-inset <INSET-NAME>
4118 \begin_layout Description
4119 Origin leeming, 25 Feb 2003
4122 \begin_layout Subsection*
4125 \begin_layout Description
4126 Action This function is called when mouse button is pressed (inside workarea). Action depends on the context.
4128 \begin_layout Description
4129 Notion This is internal LFUN, not to be used by users.
4131 \begin_layout Description
4132 Origin Andre, 9 Aug 2002
4135 \begin_layout Subsection*
4138 \begin_layout Description
4139 Action This function is called when double click on mouse button is pressed (inside workarea). Action depends on the context.
4141 \begin_layout Description
4142 Notion This is internal LFUN, not to be used by users.
4144 \begin_layout Description
4145 Origin Andre, 9 Aug 2002
4148 \begin_layout Subsection*
4151 \begin_layout Description
4152 Action This function is called when triple click on mouse button is pressed (inside workarea). Action depends on the context.
4154 \begin_layout Description
4155 Notion This is internal LFUN, not to be used by users.
4157 \begin_layout Description
4158 Origin Andre, 9 Aug 2002
4161 \begin_layout Subsection*
4164 \begin_layout Description
4165 Action This function is called when mouse cursor is moving over the text. Action depends on the context.
4167 \begin_layout Description
4168 Notion This is internal LFUN, not to be used by users.
4170 \begin_layout Description
4171 Origin Andre, 9 Aug 2002
4174 \begin_layout Subsection*
4177 \begin_layout Description
4178 Action This function is called when mouse button is released (inside workarea). Action depends on the context.
4180 \begin_layout Description
4181 Notion This is internal LFUN, not to be used by users.
4183 \begin_layout Description
4184 Origin Andre, 9 Aug 2002
4187 \begin_layout Subsection*
4190 \begin_layout Description
4191 Action Turn off the loaded keyboard map.
4193 \begin_layout Description
4197 \begin_layout Subsection*
4200 \begin_layout Description
4201 Action Turn on the primary keyboard map.
4203 \begin_layout Description
4204 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.
4205 \begin_inset Newline newline
4208 The language is to be set in the Preferences dialog.
4210 \begin_layout Description
4211 Syntax keymap-primary
4214 \begin_layout Subsection*
4215 LFUN_KEYMAP_SECONDARY
4217 \begin_layout Description
4218 Action Turn on the secondary keyboard map.
4220 \begin_layout Description
4221 Syntax keymap-secondary
4224 \begin_layout Subsection*
4227 \begin_layout Description
4228 Action Toggles keyboard maps (first/second/off).
4230 \begin_layout Description
4231 Syntax keymap-toggle
4233 \begin_layout Description
4234 Origin leeming, 30 Mar 2004
4237 \begin_layout Subsection*
4238 LFUN_SERVER_GET_LAYOUT
4240 \begin_layout Description
4241 Action Returns the current layout (that is environment) name on the cursor position.
4243 \begin_layout Description
4244 Syntax server-get-layout
4247 \begin_layout Subsection*
4248 LFUN_SERVER_GET_FILENAME
4250 \begin_layout Description
4251 Action Returns path and file name of the currently edited document.
4253 \begin_layout Description
4254 Syntax server-get-filename
4257 \begin_layout Subsection*
4258 LFUN_SERVER_GOTO_FILE_ROW
4260 \begin_layout Description
4261 Action Sets the cursor position based on the row number of generated TeX file.
4263 \begin_layout Description
4264 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).
4266 \begin_layout Description
4267 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
4269 \begin_layout Description
4270 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.
4271 \begin_inset Newline newline
4274 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.
4276 \begin_layout Description
4277 Origin Edmar, 23 Dec 1998
4280 \begin_layout Subsection*
4283 \begin_layout Description
4284 Action Sends notify message about the last key-sequence to client.
4286 \begin_layout Description
4287 Notion This can be used to grab last key-sequence used inside the LyX window. See also Debug extensions section in Additional features manual.
4289 \begin_layout Description
4290 Syntax server-notify
4293 \begin_layout Subsection*
4296 \begin_layout Description
4297 Action Sets the cursor position based on the editing area coordinates (similar as clicking on that point with left mouse button).
4299 \begin_layout Description
4300 Syntax server-set-xy <X> <Y>
4303 \begin_layout Subsection*
4306 \begin_layout Description
4307 Action Returns the coordinates of cursor position in the editing area.
4309 \begin_layout Description
4310 Syntax server-get-xy
4313 \begin_layout Subsection*
4316 \begin_layout Description
4317 Action Generates the code (literate programming).
4319 \begin_layout Description
4320 Notion Latex file with extension
4322 literate_extension is generated. Then LyX invokes
4324 build_command (with a default of``make'') to generate the code and
4326 build_error_filter to process the compilation error messages.
4327 \begin_inset Newline newline
4330 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:
4331 \begin_inset Newline newline
4336 build_command "my_script my_arguments"
4337 \begin_inset Newline newline
4342 build_error_filter differs from the
4344 literate_error_filter only in that the former will identify error messages from your compiler.
4346 \begin_layout Description
4347 Syntax build-program
4350 \begin_layout Subsection*
4351 LFUN_BUFFER_AUTO_SAVE
4353 \begin_layout Description
4354 Action Saves the current buffer to a temporary file.
4356 \begin_layout Description
4357 Notion Saves the current buffer to a file named "#filename#". This LFUN is called automatically by LyX, to "autosave" the current buffer.
4359 \begin_layout Description
4360 Syntax buffer-auto-save
4363 \begin_layout Subsection*
4364 LFUN_BUFFER_CHILD_OPEN
4366 \begin_layout Description
4367 Action Loads the given child document.
4369 \begin_layout Description
4370 Notion The current document is treated as a parent.
4372 \begin_layout Description
4373 Syntax buffer-child-open <FILE>
4375 \begin_layout Description
4376 Params <FILE>: Filename of the child. The directory of the parent is assumed by default.
4378 \begin_layout Description
4379 Origin Ale, 28 May 1997
4382 \begin_layout Subsection*
4385 \begin_layout Description
4386 Action Runs chktex for the current document.
4388 \begin_layout Description
4389 Syntax buffer-chktex
4391 \begin_layout Description
4392 Origin Asger, 30 Oct 1997
4395 \begin_layout Subsection*
4396 LFUN_BUFFER_TOGGLE_COMPRESSION
4398 \begin_layout Description
4399 Action Toggles compression of the current document on/off.
4401 \begin_layout Description
4402 Syntax buffer-toggle-compression
4404 \begin_layout Description
4405 Origin bpeng, 27 Apr 2006
4408 \begin_layout Subsection*
4411 \begin_layout Description
4412 Action Closes the current buffer.
4414 \begin_layout Description
4415 Notion Closes the current buffer, asking whether to save it, etc, if the buffer has been modified.
4417 \begin_layout Description
4421 \begin_layout Subsection*
4422 LFUN_BUFFER_CLOSE_ALL
4424 \begin_layout Description
4425 Action Closes all buffers.
4427 \begin_layout Description
4428 Notion Closes all buffers, asking whether to save it, etc, if a buffer has been modified.
4430 \begin_layout Description
4431 Syntax buffer-close-all
4434 \begin_layout Subsection*
4437 \begin_layout Description
4438 Action Exports the current buffer (document) to the given format.
4440 \begin_layout Description
4441 Syntax buffer-export <FORMAT>
4443 \begin_layout Description
4444 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.
4445 \begin_inset Newline newline
4448 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.
4450 \begin_layout Description
4451 Origin Lgb, 29 Jul 1997
4454 \begin_layout Subsection*
4455 LFUN_BUFFER_EXPORT_CUSTOM
4457 \begin_layout Description
4458 Action Exports the current buffer (document) from the given format using the given command on it.
4460 \begin_layout Description
4461 Syntax buffer-export-custom <FORMAT> <COMMAND>
4463 \begin_layout Description
4464 Params <FORMAT> format to start from (LyX will care to produce such intermediate file).
4465 \begin_inset Newline newline
4468 <COMMAND> this command will be launched on the file. Note that you can use "$$FName" string to qualify the intermediate file.
4470 \begin_layout Description
4471 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
4473 \begin_layout Description
4474 Origin leeming, 27 Mar 2004
4477 \begin_layout Subsection*
4480 \begin_layout Description
4481 Action Prints the current document.
4483 \begin_layout Description
4484 Notion Many settings can be given via the preferences dialog.
4486 \begin_layout Description
4487 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
4489 \begin_layout Description
4490 Params <TARGET> is either "printer" or "file".
4491 \begin_inset Newline newline
4494 <TARGER-NAME> is either "default" or file name or printer name.
4495 \begin_inset Newline newline
4498 <COMMAND> command ensuring the printing job.
4500 \begin_layout Description
4501 Sample buffer-print file "/trash/newfile1.ps" "dvips"
4503 \begin_layout Description
4504 Origin leeming, 28 Mar 2004
4507 \begin_layout Subsection*
4510 \begin_layout Description
4511 Action Import a given file as a lyx document.
4513 \begin_layout Description
4514 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.
4516 \begin_layout Description
4517 Syntax buffer-import <FORMAT> [<FILE>]
4519 \begin_layout Description
4520 Origin Asger, 24 Jul 1998
4523 \begin_layout Subsection*
4526 \begin_layout Description
4527 Action Creates a new buffer (that is, document).
4529 \begin_layout Description
4530 Notion Implicit path can be set in Preferences dialog.
4532 \begin_layout Description
4533 Syntax buffer-new [<FILE>]
4535 \begin_layout Description
4536 Params <FILE>: filename of created file with absolute path.
4539 \begin_layout Subsection*
4540 LFUN_BUFFER_NEW_TEMPLATE
4542 \begin_layout Description
4543 Action Creates a new buffer (that is, document) from a template.
4545 \begin_layout Description
4546 Notion Path for new files and templates can be set in Preferences dialog. Template will be asked for via Open-dialog.
4548 \begin_layout Description
4549 Syntax buffer-new-template [<FILE>]
4551 \begin_layout Description
4552 Params <FILE>: filename of created file with absolute path.
4555 \begin_layout Subsection*
4558 \begin_layout Description
4559 Action Reverts opened document.
4561 \begin_layout Description
4562 Syntax buffer-reload
4564 \begin_layout Description
4565 Origin Asger, 2 Feb 1997
4568 \begin_layout Subsection*
4571 \begin_layout Description
4572 Action Display/switch to the given buffer.
4574 \begin_layout Description
4575 Syntax buffer-switch <BUFFER>
4577 \begin_layout Description
4578 Params <BUFFER>: path and filename of already opened (but possibly hidden) document which is to be shown.
4581 \begin_layout Subsection*
4582 LFUN_BUFFER_TOGGLE_READ_ONLY
4584 \begin_layout Description
4585 Action Toggle editing mode of the current document between read/write and read-only.
4587 \begin_layout Description
4588 Notion This function is not allowed if the file is under version control, since read-only flag is often used in version control file locking.
4590 \begin_layout Description
4591 Syntax buffer-toggle-read-only
4593 \begin_layout Description
4594 Origin Lgb, 27 May 1997
4597 \begin_layout Subsection*
4600 \begin_layout Description
4601 Action Displays current buffer in chosen format.
4603 \begin_layout Description
4604 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.
4606 \begin_layout Description
4607 Syntax buffer-view [<FORMAT>]
4609 \begin_layout Description
4610 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.
4613 \begin_layout Subsection*
4616 \begin_layout Description
4617 Action Exports the current document and put the result into the temporary directory.
4619 \begin_layout Description
4620 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).
4622 \begin_layout Description
4623 Syntax buffer-update [<FORMAT>]
4625 \begin_layout Description
4626 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.
4628 \begin_layout Description
4629 Origin Dekel, 5 Aug 2000
4632 \begin_layout Subsection*
4635 \begin_layout Description
4636 Action Saves the current buffer.
4638 \begin_layout Description
4639 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.
4641 \begin_layout Description
4645 \begin_layout Subsection*
4646 LFUN_BUFFER_WRITE_AS
4648 \begin_layout Description
4649 Action Rename and save current buffer.
4651 \begin_layout Description
4652 Syntax buffer-write-as <FILENAME>
4654 \begin_layout Description
4655 Params <FILENAME>: New name of the buffer/file. A relative path is with respect to the original location of the buffer/file.
4658 \begin_layout Subsection*
4659 LFUN_BUFFER_WRITE_ALL
4661 \begin_layout Description
4662 Action Save all changed documents.
4664 \begin_layout Description
4665 Syntax buffer-write-all
4667 \begin_layout Description
4668 Origin rgh, gpothier 6 Aug 2007
4671 \begin_layout Subsection*
4674 \begin_layout Description
4675 Action Switch to the next opened document.
4677 \begin_layout Description
4678 Notion Note that this does not necessarily mean next in tabbar (for full list see View menu).
4680 \begin_layout Description
4684 \begin_layout Subsection*
4685 LFUN_BUFFER_PREVIOUS
4687 \begin_layout Description
4688 Action Switch to the previous opened document.
4690 \begin_layout Description
4691 Syntax buffer-previous
4694 \begin_layout Subsection*
4695 LFUN_MASTER_BUFFER_UPDATE
4697 \begin_layout Description
4698 Action When run from a child document, this updates (exports) document built from the master buffer, if available.
4700 \begin_layout Description
4701 Syntax master-buffer-update [<FORMAT>]
4703 \begin_layout Description
4704 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.
4706 \begin_layout Description
4707 Origin Tommaso, 20 Sep 2007
4710 \begin_layout Subsection*
4711 LFUN_MASTER_BUFFER_VIEW
4713 \begin_layout Description
4714 Action When run from a child document, this command shows a preview built from the master buffer, if available.
4716 \begin_layout Description
4717 Syntax master-buffer-view [<FORMAT>]
4719 \begin_layout Description
4720 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.
4722 \begin_layout Description
4723 Origin Tommaso, 20 Sep 2007
4726 \begin_layout Subsection*
4727 LFUN_BUFFER_LANGUAGE
4729 \begin_layout Description
4730 Action Set language of the current document.
4732 \begin_layout Description
4733 Syntax buffer-language <LANG>
4735 \begin_layout Description
4736 Params <LANG>: language name. See lib/languages for list.
4738 \begin_layout Description
4739 Origin leeming, 30 Mar 2004
4742 \begin_layout Subsection*
4743 LFUN_BUFFER_SAVE_AS_DEFAULT
4745 \begin_layout Description
4746 Action Save the current document settings as default.
4748 \begin_layout Description
4749 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
4751 \begin_layout Description
4752 Syntax buffer-save-as-default [<ARGS>]
4754 \begin_layout Description
4755 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4757 \begin_layout Description
4758 Origin leeming, 30 Mar 2004
4761 \begin_layout Subsection*
4762 LFUN_BUFFER_PARAMS_APPLY
4764 \begin_layout Description
4765 Action Apply the given settings to the current document.
4767 \begin_layout Description
4768 Syntax buffer-params-apply [<ARGS>]
4770 \begin_layout Description
4771 Params <ARGS>: contains the particular settings to be saved. They obey the syntax you can find in document header of usual .lyx file.
4773 \begin_layout Description
4774 Origin leeming, 30 Mar 2004
4777 \begin_layout Subsection*
4780 \begin_layout Description
4781 Action Inserts another LyX file.
4783 \begin_layout Description
4784 Syntax file-insert [<FILE>]
4786 \begin_layout Description
4787 Params <FILE>: Filename to be inserted.
4790 \begin_layout Subsection*
4791 LFUN_FILE_INSERT_PLAINTEXT
4793 \begin_layout Description
4794 Action Inserts plain text file.
4796 \begin_layout Description
4797 Syntax file-insert-plaintext [<FILE>]
4799 \begin_layout Description
4800 Params <FILE>: Filename to be inserted.
4802 \begin_layout Description
4803 Origin CFO-G, 19 Nov 1997
4806 \begin_layout Subsection*
4807 LFUN_FILE_INSERT_PLAINTEXT_PARA
4809 \begin_layout Description
4810 Action Inserts plain text file as paragraph (i.e. join lines).
4812 \begin_layout Description
4813 Syntax file-insert-plaintext-para [<FILE>]
4815 \begin_layout Description
4816 Params <FILE>: Filename to be inserted.
4818 \begin_layout Description
4819 Origin Levon, 14 Feb 2001
4822 \begin_layout Subsection*
4825 \begin_layout Description
4826 Action Open LyX document.
4828 \begin_layout Description
4829 Syntax file-open [<FILE>]
4831 \begin_layout Description
4832 Params <FILE>: Filename to be opened.
4835 \begin_layout Subsection*
4838 \begin_layout Description
4839 Action Executes a command defined in a .def file.
4841 \begin_layout Description
4842 Notion The definitions are by default read from lib/commands/default.def.
4843 \begin_inset Newline newline
4846 A .def file allows to define a command with
4848 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).
4850 def_file "FileName" allows to include another .def file.
4851 \begin_inset Newline newline
4854 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.
4856 \begin_layout Description
4859 \begin_layout Description
4860 Params <NAME>: Name of the command that must be called.
4862 \begin_layout Description
4863 Origin broider, 2 Oct 2007
4866 \begin_layout Subsection*
4869 \begin_layout Description
4870 Action Simulate halting Meta key (Alt key on PCs).
4872 \begin_layout Description
4873 Notion Used for buffer editation not for GUI control.
4875 \begin_layout Description
4879 \begin_layout Subsection*
4882 \begin_layout Description
4883 Action Cancels sequence prepared by LFUN_META_PREFIX .
4885 \begin_layout Description
4889 \begin_layout Subsection*
4890 LFUN_COMMAND_EXECUTE
4892 \begin_layout Description
4893 Action Switches the focus to the minibuffer so that the user can type in there. If necessary, it opens the minibuffer toolbar.
4895 \begin_layout Description
4896 Notion Usually bound to M-x shortcut.
4898 \begin_layout Description
4899 Syntax command-execute
4902 \begin_layout Subsection*
4905 \begin_layout Description
4906 Action Return the current key sequence and available options as a string.
4908 \begin_layout Description
4909 Notion No options are added if no current map exists.
4910 \begin_inset Newline newline
4913 This is probably usable only with connection to lyxserver.
4915 \begin_layout Description
4916 Syntax command-prefix
4919 \begin_layout Subsection*
4920 LFUN_COMMAND_SEQUENCE
4922 \begin_layout Description
4923 Action Run more commands (LFUN and its parameters) in a sequence.
4925 \begin_layout Description
4926 Syntax command-sequence <CMDS>
4928 \begin_layout Description
4929 Params <CMDS>: Sequence of commands separated by semicolons.
4931 \begin_layout Description
4932 Sample command-sequence cut; ert-insert; self-insert
4934 ; paste; self-insert {}; inset-toggle;
4936 \begin_layout Description
4937 Origin Andre, 11 Nov 1999
4940 \begin_layout Subsection*
4941 LFUN_COMMAND_ALTERNATIVES
4943 \begin_layout Description
4944 Action Runs the first listed command that is enabled.
4946 \begin_layout Description
4947 Notion This can be used to bind multiple functions to a single key, and then which one is used will depend upon the context.
4949 \begin_layout Description
4950 Syntax command-alternatives <CMDS>
4952 \begin_layout Description
4953 Params <CMDS>: Sequence of commands separated by semicolons.
4955 \begin_layout Description
4956 Sample command-alternatives completion-accept;cell-forward
4958 \begin_layout Description
4959 Origin rgh, 24 September 2008
4962 \begin_layout Subsection*
4965 \begin_layout Description
4966 Action Shows message in statusbar (for script purposes).
4968 \begin_layout Description
4969 Syntax message <STRING>
4971 \begin_layout Description
4972 Origin Lgb, 8 Apr 2001
4975 \begin_layout Subsection*
4976 LFUN_DEBUG_LEVEL_SET
4978 \begin_layout Description
4979 Action Set debug output level.
4981 \begin_layout Description
4982 Syntax debug-level-set <LEVEL>
4984 \begin_layout Description
4985 Params <LEVEL>: comma separated list of levels or the correspondent number of their combination. 0 is equivalent to disabling all debug events. See lyx -dbg for the current list of debug levels and their numbers.
4987 \begin_layout Description
4988 Origin sanda, 28 Dec 2009
4991 \begin_layout Subsection*
4992 LFUN_PREFERENCES_SAVE
4994 \begin_layout Description
4995 Action Save user preferences.
4997 \begin_layout Description
4998 Syntax preferences-save
5000 \begin_layout Description
5001 Origin Lgb, 27 Nov 1999
5004 \begin_layout Subsection*
5007 \begin_layout Description
5008 Action Reconfigure the automatic settings.
5010 \begin_layout Description
5013 \begin_layout Description
5014 Origin Asger, 14 Feb 1997
5017 \begin_layout Subsection*
5020 \begin_layout Description
5021 Action Apply the given settings to user preferences.
5023 \begin_layout Description
5024 Syntax lyxrc-apply <SETTINGS>
5026 \begin_layout Description
5027 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.
5030 \begin_layout Subsection*
5031 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
5033 \begin_layout Description
5034 Action Determine whether keep cursor inside the editing window regardless the scrollbar movement.
5036 \begin_layout Description
5037 Syntax toggle-cursor-follows-scrollbar
5039 \begin_layout Description
5040 Origin ARRae, 2 Dec 1997
5043 \begin_layout Subsection*
5046 \begin_layout Description
5047 Action Set the given LyX color to the color defined by the X11 name given.
5049 \begin_layout Description
5050 Notion A new color entry is created if the color is unknown. Color names can be stored as a part of user settings.
5052 \begin_layout Description
5053 Syntax set-color <LYX_NAME> <X11_NAME>
5055 \begin_layout Description
5056 Origin SLior, 11 Jun 2000
5059 \begin_layout Subsection*
5062 \begin_layout Description
5063 Action Count the statistics (number of words and characters) in the document or in the given selection.
5065 \begin_layout Description
5066 Notion Note that this function gives the number of words/chars written, not the number of characters which will be typeset.
5068 \begin_layout Description
5071 \begin_layout Description
5072 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
5075 \begin_layout Subsection*
5076 LFUN_COMPLETION_INLINE
5078 \begin_layout Description
5079 Action Show the inline completion at the cursor position.
5081 \begin_layout Description
5082 Syntax completion-inline
5084 \begin_layout Description
5085 Origin sts, Feb 19 2008
5088 \begin_layout Subsection*
5089 LFUN_COMPLETION_POPUP
5091 \begin_layout Description
5092 Action Show the completion popup at the cursor position.
5094 \begin_layout Description
5095 Syntax completion-popup
5097 \begin_layout Description
5098 Origin sts, Feb 19 2008
5101 \begin_layout Subsection*
5102 LFUN_COMPLETION_COMPLETE
5104 \begin_layout Description
5105 Action Try to complete the word or command at the cursor position.
5107 \begin_layout Description
5110 \begin_layout Description
5111 Origin sts, Feb 19 2008
5114 \begin_layout Subsection*
5115 LFUN_COMPLETION_CANCEL
5117 \begin_layout Description
5118 Action Try to cancel completion, either the popup or the inline completion.
5120 \begin_layout Description
5121 Syntax completion-cancel
5123 \begin_layout Description
5124 Origin sts, Sep 07 2008
5127 \begin_layout Subsection*
5128 LFUN_COMPLETION_ACCEPT
5130 \begin_layout Description
5131 Action Accept suggested completion.
5133 \begin_layout Description
5134 Syntax completion-accept
5136 \begin_layout Description
5137 Origin sanda, Sep 08 2008
5140 \begin_layout Subsection*
5143 \begin_layout Description
5144 Action Add a branch to the buffer's BranchList.
5146 \begin_layout Description
5147 Syntax branch-add <BRANCH>
5149 \begin_layout Description
5150 Params <BRANCH>: Name of the branch to add
5152 \begin_layout Description
5153 Origin spitz, 7 Jul 2009
5156 \begin_layout Subsection*
5157 LFUN_BRANCH_ACTIVATE
5159 \begin_layout Description
5160 Action Activate the branch.
5162 \begin_layout Description
5163 Syntax branch-activate <BRANCH>
5165 \begin_layout Description
5166 Params <BRANCH>: The branch to activate
5168 \begin_layout Description
5169 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
5170 \begin_inset Newline newline
5173 could be used to export a pdf with the answers branch included without one's having to open LyX and activate the branch manually.
5175 \begin_layout Description
5176 Origin rgh, 27 May 2008
5179 \begin_layout Subsection*
5180 LFUN_BRANCH_DEACTIVATE
5182 \begin_layout Description
5183 Action De-activate the branch.
5185 \begin_layout Description
5186 Syntax branch-deactivate <BRANCH>
5188 \begin_layout Description
5189 Params <BRANCH>: The branch to deactivate
5191 \begin_layout Description
5192 Origin rgh, 27 May 2008
5195 \begin_layout Subsection*
5196 LFUN_BRANCHES_RENAME
5198 \begin_layout Description
5199 Action Rename all branches of a given name in a document.
5201 \begin_layout Description
5202 Syntax branches-rename <OLDNAME> <NEWNAME>
5204 \begin_layout Description
5205 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New name of the branch
5207 \begin_layout Description
5208 Origin spitz, 9 Jul 2009
5211 \begin_layout Subsection*
5212 LFUN_BRANCH_ADD_INSERT
5214 \begin_layout Description
5215 Action Create new branch and directly put the branch inset into the document.
5217 \begin_layout Description
5218 Syntax branch-add-insert [<NAME>]
5220 \begin_layout Description
5221 Params <NAME>: Branch name. If it is not specified, you will be asked.
5223 \begin_layout Description
5224 Origin sanda, 10 Jul 2009
5227 \begin_layout Subsection*
5228 LFUN_LABEL_COPY_AS_REF
5230 \begin_layout Description
5231 Action Copies the label at the cursor as a cross-reference to be pasted elsewhere.
5233 \begin_layout Description
5234 Syntax copy-label-as-reference <LABEL>
5236 \begin_layout Description
5237 Params <LABEL>: The label to copy (for multi-line math)
5239 \begin_layout Description
5240 Origin sts, 16 Nov 2008
5243 \begin_layout Subsection*
5244 LFUN_LABEL_INSERT_AS_REF
5246 \begin_layout Description
5247 Action Inserts the label as a cross-reference at the position of the cursor.
5249 \begin_layout Description
5250 Syntax label-insert-as-reference
5252 \begin_layout Description
5253 Origin vfr, 7 Apr 2009
5256 \begin_layout Subsection*
5259 \begin_layout Description
5260 Action Increases the zoom of the screen fonts.
5262 \begin_layout Description
5263 Syntax buffer-zoom-in [<ZOOM>]
5265 \begin_layout Description
5266 Params <ZOOM>: The zoom in %, the default is 20.
5268 \begin_layout Description
5269 Origin vfr, 30 Mar 2009
5272 \begin_layout Subsection*
5273 LFUN_BUFFER_ZOOM_OUT
5275 \begin_layout Description
5276 Action Decreases the zoom of the screen fonts.
5278 \begin_layout Description
5279 Syntax buffer-zoom-out [<ZOOM>]
5281 \begin_layout Description
5282 Params <ZOOM>: The zoom in %, the default is 20.
5284 \begin_layout Description
5285 Origin vfr, 30 Mar 2009
projects / lyx.git / blob