Mercurial > hgrepos > hgweb.cgi > yatex
comparison docs/yatexe @ 279:784b25b062cc yatex-1.76
RCS-Checked in as 1.76
author | HIROSE Yuuji <yuuji@gentei.org> |
---|---|
date | Mon, 14 May 2012 20:03:27 +0900 |
parents | 78d0fdc0459c |
children | d0c09133ced7 |
comparison
equal
deleted
inserted
replaced
277:29ab3f4fcd9e | 279:784b25b062cc |
---|---|
1 Info file: yatexe, -*-Text-*- | 1 Info file: yatexe, -*-Text-*- |
2 produced by `texinfo-format-buffer' | 2 produced by `texinfo-format-buffer' |
3 from file `yatexe.tex' | 3 from file `yatexe.tex' |
4 using `texinfmt.el' version 2.38 of 3 July 1998. | 4 using `texinfmt.el' version 2.42 of 7 Jul 2006. |
5 | 5 |
6 START-INFO-DIR-ENTRY | 6 START-INFO-DIR-ENTRY |
7 * YaTeX-e: (yatexe). Yet Another tex-mode for Emacs (English). | 7 * YaTeX-e: (yatexe). Yet Another tex-mode for Emacs (English). |
8 END-INFO-DIR-ENTRY | 8 END-INFO-DIR-ENTRY |
9 | 9 |
14 | 14 |
15 File: yatexe, Node: Top, Next: What is YaTeX?, Prev: (dir), Up: (dir) | 15 File: yatexe, Node: Top, Next: What is YaTeX?, Prev: (dir), Up: (dir) |
16 | 16 |
17 * Menu: | 17 * Menu: |
18 | 18 |
19 * What is YaTeX?:: | 19 * What is YaTeX?:: |
20 * Main features:: What YaTeX can do | 20 * Main features:: What YaTeX can do |
21 * Installation:: Guide to install | 21 * Installation:: Guide to install |
22 * Typesetting:: Call typesetting processes | 22 * Typesetting:: Call typesetting processes |
23 * %#notation:: Meta-keyword `%#' | 23 * %#notation:: Meta-keyword `%#' |
24 * Completion:: Input LaTeX commands with completion | 24 * Completion:: Input LaTeX commands with completion |
45 | 45 |
46 What is YaTeX? | 46 What is YaTeX? |
47 ************** | 47 ************** |
48 | 48 |
49 YaTeX automates typesetting and previewing of LaTeX and enables | 49 YaTeX automates typesetting and previewing of LaTeX and enables |
50 completing input of LaTeX mark-up command such as `\begin{}'..`\end{}'. | 50 completing input of LaTeX mark-up command such as |
51 `\begin{}'..`\end{}'. | |
51 | 52 |
52 YaTeX also supports Demacs which runs on MS-DOS(386), Mule (Multi | 53 YaTeX also supports Demacs which runs on MS-DOS(386), Mule (Multi |
53 Language Enhancement to GNU Emacs), and latex on DOS. | 54 Language Enhancement to GNU Emacs), and latex on DOS. |
54 | 55 |
55 | 56 |
129 ... invoke latex on region | 130 ... invoke latex on region |
130 `[prefix] t e' | 131 `[prefix] t e' |
131 ... invoke latex on current environment or whole portion of | 132 ... invoke latex on current environment or whole portion of |
132 current formulas in math-mode. | 133 current formulas in math-mode. |
133 `[prefix] t d' | 134 `[prefix] t d' |
134 ... invoke dvipdfmx after successful typesetting | 135 ... invoke dvipdfmx after successful typesetting |
135 `[prefix] t k' | 136 `[prefix] t k' |
136 ... kill current typesetting process | 137 ... kill current typesetting process |
137 `[prefix] t b' | 138 `[prefix] t b' |
138 ... invoke bibtex | 139 ... invoke bibtex |
139 `[prefix] t i' | 140 `[prefix] t i' |
147 `[prefix] t s' | 148 `[prefix] t s' |
148 ... search current string on xdvi-remote | 149 ... search current string on xdvi-remote |
149 | 150 |
150 * Menu: | 151 * Menu: |
151 | 152 |
152 * Calling typesetter:: | 153 * Calling typesetter:: |
153 * Calling previewer:: | 154 * Calling previewer:: |
154 * Printing out:: | 155 * Printing out:: |
155 | 156 |
156 | 157 |
157 | 158 |
158 File: yatexe, Node: Calling typesetter, Next: Calling previewer, Prev: Typesetting, Up: Typesetting | 159 File: yatexe, Node: Calling typesetter, Next: Calling previewer, Prev: Typesetting, Up: Typesetting |
159 | 160 |
236 You can control the typesetting process by describing `%#' notations in | 237 You can control the typesetting process by describing `%#' notations in |
237 the source text. | 238 the source text. |
238 | 239 |
239 * Menu: | 240 * Menu: |
240 | 241 |
241 * Changing typesetter:: | 242 * Changing typesetter:: |
242 * Splitting input files:: | 243 * Splitting input files:: |
243 * Static region for typesetting:: | 244 * Static region for typesetting:: |
244 * Lpr format:: | 245 * Lpr format:: |
245 * Controlling which command to invoke:: | 246 * Controlling which command to invoke:: |
246 * Editing %# notation:: | 247 * Editing %# notation:: |
247 | 248 |
248 | 249 |
249 | 250 |
250 File: yatexe, Node: Changing typesetter, Next: Splitting input files, Prev: %#notation, Up: %#notation | 251 File: yatexe, Node: Changing typesetter, Next: Splitting input files, Prev: %#notation, Up: %#notation |
251 | 252 |
369 | 370 |
370 These %# notation below can control which command to invoke for LaTeX | 371 These %# notation below can control which command to invoke for LaTeX |
371 related process. | 372 related process. |
372 | 373 |
373 `%#BIBTEX' | 374 `%#BIBTEX' |
374 | 375 |
375 ... Command line for makeindex ([prefix] t i) | 376 ... Command line for makeindex ([prefix] t i) |
376 `%#MAKEINDEX' | 377 `%#MAKEINDEX' |
377 | 378 |
378 ... Command line for bibtex ([prefix] t b) | 379 ... Command line for bibtex ([prefix] t b) |
379 | 380 |
380 If you want to invoke "makeidx hogehoge" to update index, put the next | 381 If you want to invoke "makeidx hogehoge" to update index, put the next |
381 line some upper place in the source, for example. | 382 line some upper place in the source, for example. |
382 | 383 |
383 %#MAKEINDEX makeidx hogehoge | 384 %#MAKEINDEX makeidx hogehoge |
413 YaTeX makes it easy to input the LaTeX commands. There are several | 414 YaTeX makes it easy to input the LaTeX commands. There are several |
414 kinds of completion type, begin-type, section-type, large-type, etc... | 415 kinds of completion type, begin-type, section-type, large-type, etc... |
415 | 416 |
416 * Menu: | 417 * Menu: |
417 | 418 |
418 * Begin-type completion:: | 419 * Begin-type completion:: |
419 * Section-type completion:: | 420 * Section-type completion:: |
420 * Large-type completion:: | 421 * Large-type completion:: |
421 * Maketitle-type completion:: | 422 * Maketitle-type completion:: |
422 * Arbitrary completion:: | 423 * Arbitrary completion:: |
423 * End completion:: | 424 * End completion:: |
424 * Accent completion:: | 425 * Accent completion:: |
425 * Image completion:: | 426 * Image completion:: |
426 * Greek letters completion:: | 427 * Greek letters completion:: |
427 | 428 |
428 | 429 |
429 | 430 |
430 File: yatexe, Node: Begin-type completion, Next: Section-type completion, Prev: Completion, Up: Completion | 431 File: yatexe, Node: Begin-type completion, Next: Section-type completion, Prev: Completion, Up: Completion |
431 | 432 |
483 `[prefix] b SPACE' | 484 `[prefix] b SPACE' |
484 ... begin-type completion | 485 ... begin-type completion |
485 | 486 |
486 The next message will show up in the minibuffer | 487 The next message will show up in the minibuffer |
487 | 488 |
488 Begin environment(default document): | 489 Begin environment(default document): |
489 | 490 |
490 by typing `[prefix] b'. Put the wishing environment with completion in | 491 by typing `[prefix] b'. Put the wishing environment with completion in |
491 the minibuffer, and `\begin{env}'...\`\end{env}' will be inserted in the | 492 the minibuffer, and `\begin{env}'...\`\end{env}' will be inserted in the |
492 LaTeX source text. If the environment you want to put does not exist in | 493 LaTeX source text. If the environment you want to put does not exist in |
493 the YaTeX completion table, it will be registered in the user completion | 494 the YaTeX completion table, it will be registered in the user completion |
551 \section{Hello world.} | 552 \section{Hello world.} |
552 | 553 |
553 in your LaTeX source. When you neglect argument such as | 554 in your LaTeX source. When you neglect argument such as |
554 | 555 |
555 (C-v for view) \???{} (default section): vspace* | 556 (C-v for view) \???{} (default section): vspace* |
556 \vspace*{???}: | 557 \vspace*{???}: |
557 | 558 |
558 YaTeX puts | 559 YaTeX puts |
559 | 560 |
560 \vspace*{} | 561 \vspace*{} |
561 | 562 |
590 efficiently read with the recursive completion by typing YaTeX's | 591 efficiently read with the recursive completion by typing YaTeX's |
591 completion key sequence in the minibuffer. | 592 completion key sequence in the minibuffer. |
592 | 593 |
593 * Menu: | 594 * Menu: |
594 | 595 |
595 * view-sectioning:: | 596 * view-sectioning:: |
596 | 597 |
597 | 598 |
598 | 599 |
599 File: yatexe, Node: view-sectioning, Prev: Section-type completion, Up: Section-type completion | 600 File: yatexe, Node: view-sectioning, Prev: Section-type completion, Up: Section-type completion |
600 | 601 |
613 You can generate this listing buffer (`*Sectioning Lines*' buffer) by | 614 You can generate this listing buffer (`*Sectioning Lines*' buffer) by |
614 typing | 615 typing |
615 `M-x YaTeX-section-overview' | 616 `M-x YaTeX-section-overview' |
616 ... Generate *Sectioning Lines* buffer | 617 ... Generate *Sectioning Lines* buffer |
617 | 618 |
618 from the LaTeX source buffer. In this listing buffer, typing `u' on the | 619 from the LaTeX source buffer. In this listing buffer, typing `u' on |
619 sectioning command shifts up the corresponding sectioning command in | 620 the sectioning command shifts up the corresponding sectioning command in |
620 source text and `d' shifts down. After marking lines in the listing | 621 source text and `d' shifts down. After marking lines in the listing |
621 buffer, typing `U' shifts up all sectioning commands in the region, and | 622 buffer, typing `U' shifts up all sectioning commands in the region, |
622 `U' shifts down. Here are all the key bindings of `*Sectioning Lines*' | 623 and `U' shifts down. Here are all the key bindings of |
623 buffer. | 624 `*Sectioning Lines*' buffer. |
624 | 625 |
625 `SPC' | 626 `SPC' |
626 ... Jump to corresponding source line | 627 ... Jump to corresponding source line |
627 `.' | 628 `.' |
628 ... Display corresponding source line | 629 ... Display corresponding source line |
651 `[prefix] l' | 652 `[prefix] l' |
652 ... large-type completion | 653 ... large-type completion |
653 | 654 |
654 the message in the minibuffer | 655 the message in the minibuffer |
655 | 656 |
656 {\??? } (default large): | 657 {\??? } (default large): |
657 | 658 |
658 prompts prompts you large-type command with completing-read. There are | 659 prompts prompts you large-type command with completing-read. There are |
659 TeX commands to change fonts or sizes, `it', `huge' and so on, in the | 660 TeX commands to change fonts or sizes, `it', `huge' and so on, in the |
660 completion table. | 661 completion table. |
661 | 662 |
702 | 703 |
703 End completion | 704 End completion |
704 ============== | 705 ============== |
705 | 706 |
706 YaTeX automatically detects the opened environment and close it with | 707 YaTeX automatically detects the opened environment and close it with |
707 \`\end{environment}'. Though proficient YaTeX users never fail to make | 708 `\end{environment}'. Though proficient YaTeX users never fail to make |
708 environment with begin-type completion, some may begin an environment | 709 environment with begin-type completion, some may begin an environment |
709 manually. In that case, type | 710 manually. In that case, type |
710 | 711 |
711 `[prefix] e' | 712 `[prefix] e' |
712 ... `end' completion | 713 ... `end' completion |
753 symbols graphically. This completion only works in the math environment. | 754 symbols graphically. This completion only works in the math environment. |
754 YaTeX automatically detects whether the cursor located in math environment | 755 YaTeX automatically detects whether the cursor located in math environment |
755 or not, and change the behavior of key strokes `;' and `:'. | 756 or not, and change the behavior of key strokes `;' and `:'. |
756 | 757 |
757 By the way, we often express the leftarrow mark by `<-' for example. | 758 By the way, we often express the leftarrow mark by `<-' for example. |
758 Considering such image, you can write `\leftarrow' by typing `<-' after | 759 Considering such image, you can write `\leftarrow' by typing `<-' |
759 `;' (semicolon) as a prefix. In the same way, `\longleftarrow' (`<--') is | 760 after `;' (semicolon) as a prefix. In the same way, |
760 completed by typing `;<--', infinity mark which is imitated by `oo' is | 761 `\longleftarrow' (`<--') is completed by typing `;<--', |
761 completed by typing `;oo'. | 762 infinity mark which is imitated by `oo' is completed by typing |
763 `;oo'. | |
762 | 764 |
763 Here are the sample operations in YaTeX math-mode. | 765 Here are the sample operations in YaTeX math-mode. |
764 | 766 |
765 INPUT Completed LaTeX commands | 767 INPUT Completed LaTeX commands |
766 ; < - `\leftarrow' | 768 ; < - `\leftarrow' |
770 ; o o `\infty' | 772 ; o o `\infty' |
771 | 773 |
772 In any case, you can quit from image completion and can move to the next | 774 In any case, you can quit from image completion and can move to the next |
773 editing operation if the LaTeX command you want is shown in the buffer. | 775 editing operation if the LaTeX command you want is shown in the buffer. |
774 | 776 |
775 `;' itself in math-environment is inserted by `;;'. Typing `TAB' in the | 777 `;' itself in math-environment is inserted by `;;'. Typing |
776 midst of image completion shows all of the LaTeX commands that start with | 778 `TAB' in the midst of image completion shows all of the LaTeX |
777 the same name as string you previously typed in. In this menu buffer, | 779 commands that start with the same name as string you previously typed in. |
778 press `RET' after moving the cursor (by `n', `p', `b', `f') to insert the | 780 In this menu buffer, press `RET' after moving the cursor (by `n', |
779 LaTeX command. | 781 `p', `b', `f') to insert the LaTeX command. |
780 | 782 |
781 To know all of the completion table, type `TAB' just after `;'. And | 783 To know all of the completion table, type `TAB' just after `;'. And |
782 here is the sample menu by `TAB' after `;<'. | 784 here is the sample menu by `TAB' after `;<'. |
783 | 785 |
784 KEY LaTeX sequence sign | 786 KEY LaTeX sequence sign |
785 < \leq < | 787 < \leq < |
786 ~ | 788 ~ |
787 << \ll << | 789 << \ll << |
788 <- \leftarrow <- | 790 <- \leftarrow <- |
789 <= \Leftarrow <= | 791 <= \Leftarrow <= |
790 | 792 |
791 You can define your favorite key-vs-sequence completion table in the | 793 You can define your favorite key-vs-sequence completion table in the |
792 Emacs-Lisp variable `YaTeX-math-sign-alist-private'. See also | 794 Emacs-Lisp variable `YaTeX-math-sign-alist-private'. See also |
802 Math-mode of YaTeX provides another image completion, Greek letters | 804 Math-mode of YaTeX provides another image completion, Greek letters |
803 completion in the same method. After prefix `:', typing `a' makes | 805 completion in the same method. After prefix `:', typing `a' makes |
804 `\alpha', `b' makes `\beta' and `g' makes `\gamma' and so on. First, type | 806 `\alpha', `b' makes `\beta' and `g' makes `\gamma' and so on. First, type |
805 `:TAB' to know all the correspondence of alphabets vs. Greek letters. | 807 `:TAB' to know all the correspondence of alphabets vs. Greek letters. |
806 | 808 |
807 If you will find `;' or `:' doesn't work in correct position of math | 809 If you will find `;' or `:' doesn't work in correct position of |
808 environment, it may be a bug of YaTeX. Please send me a bug report with | 810 math environment, it may be a bug of YaTeX. Please send me a bug report |
809 the configuration of your text, and avoid it temporarily by typing `;' or | 811 with the configuration of your text, and avoid it temporarily by typing |
810 `:' after universal-argument(`C-u') which forces `;' and `:' to work as | 812 `;' or `:' after universal-argument(`C-u') which forces |
811 math-prefix. | 813 `;' and `:' to work as math-prefix. |
812 | 814 |
813 | 815 |
814 | 816 |
815 File: yatexe, Node: Local dictionaries, Next: Commenting out, Prev: Completion, Up: Top | 817 File: yatexe, Node: Local dictionaries, Next: Commenting out, Prev: Completion, Up: Top |
816 | 818 |
860 comments or uncomments the paragraph where the cursor belongs. This | 862 comments or uncomments the paragraph where the cursor belongs. This |
861 `paragraph' means the region marked by the function mark-paragraph, bound | 863 `paragraph' means the region marked by the function mark-paragraph, bound |
862 to `ESC h' by default. It is NOT predictable what will happen when you | 864 to `ESC h' by default. It is NOT predictable what will happen when you |
863 continuously comment out some paragraph many times. | 865 continuously comment out some paragraph many times. |
864 | 866 |
865 You can also comment out an environment between `\begin' and `\end', or | 867 You can also comment out an environment between `\begin' and |
866 a `\begin'-\`\end' pair themselves, by making the following key strokes on | 868 `\end', or a `\begin'-\`\end' pair themselves, by making the |
867 the line where `\begin{}' or `\end{}' exists. | 869 following key strokes on the line where `\begin{}' or |
870 `\end{}' exists. | |
868 | 871 |
869 `[prefix] >' | 872 `[prefix] >' |
870 ... comment out from \begin to \`end' | 873 ... comment out from \begin to \`end' |
871 `[prefix] <' | 874 `[prefix] <' |
872 ... uncomment from \begin to \`end' | 875 ... uncomment from \begin to \`end' |
892 *********** | 895 *********** |
893 | 896 |
894 | 897 |
895 * Menu: | 898 * Menu: |
896 | 899 |
897 * Jump to corresponding object:: | 900 * Jump to corresponding object:: |
898 * Invoking image processor:: | 901 * Invoking image processor:: |
899 * Jump to main file:: | 902 * Jump to main file:: |
900 * Jumping around the environment:: | 903 * Jumping around the environment:: |
901 * Jumping to last completion position:: | 904 * Jumping to last completion position:: |
902 | 905 |
903 | 906 |
904 | 907 |
905 File: yatexe, Node: Jump to corresponding object, Next: Invoking image processor, Prev: Cursor jump, Up: Cursor jump | 908 File: yatexe, Node: Jump to corresponding object, Next: Invoking image processor, Prev: Cursor jump, Up: Cursor jump |
906 | 909 |
934 the main text, YaTeX switches buffer to `chap1.tex'. | 937 the main text, YaTeX switches buffer to `chap1.tex'. |
935 | 938 |
936 `[prefix] 4 g' | 939 `[prefix] 4 g' |
937 ... go to corresponding object in other window | 940 ... go to corresponding object in other window |
938 | 941 |
939 do the same job as `[prefix] g' except it's done in other window. Note | 942 do the same job as `[prefix] g' except it's done in other window. |
940 that this function doesn't work on `begin/end', `%#BEGIN/%#END' pairs | 943 Note that this function doesn't work on `begin/end', |
941 because it is meaningless. | 944 `%#BEGIN/%#END' pairs because it is meaningless. |
942 | 945 |
943 | 946 |
944 | 947 |
945 File: yatexe, Node: Invoking image processor, Next: Jump to main file, Prev: Jump to corresponding object, Up: Cursor jump | 948 File: yatexe, Node: Invoking image processor, Next: Jump to main file, Prev: Jump to corresponding object, Up: Cursor jump |
946 | 949 |
980 `[prefix] ^' | 983 `[prefix] ^' |
981 ... visit main file | 984 ... visit main file |
982 `[prefix] 4^' | 985 `[prefix] 4^' |
983 ... visit main file in other buffer | 986 ... visit main file in other buffer |
984 | 987 |
985 in a sub text switch the buffer to the main text specified by `%#!' | 988 in a sub text switch the buffer to the main text specified by |
986 notation. | 989 `%#!' notation. |
987 | 990 |
988 | 991 |
989 | 992 |
990 File: yatexe, Node: Jumping around the environment, Next: Jumping to last completion position, Prev: Jump to main file, Up: Cursor jump | 993 File: yatexe, Node: Jumping around the environment, Next: Jumping to last completion position, Prev: Jump to main file, Up: Cursor jump |
991 | 994 |
1029 `[prefix] k' | 1032 `[prefix] k' |
1030 ... kill LaTeX command | 1033 ... kill LaTeX command |
1031 | 1034 |
1032 * Menu: | 1035 * Menu: |
1033 | 1036 |
1034 * Changing LaTeX commands:: | 1037 * Changing LaTeX commands:: |
1035 * Killing LaTeX commands:: | 1038 * Killing LaTeX commands:: |
1036 | 1039 |
1037 | 1040 |
1038 | 1041 |
1039 File: yatexe, Node: Changing LaTeX commands, Next: Killing LaTeX commands, Prev: Changing and Deleting, Up: Changing and Deleting | 1042 File: yatexe, Node: Changing LaTeX commands, Next: Killing LaTeX commands, Prev: Changing and Deleting, Up: Changing and Deleting |
1040 | 1043 |
1113 newcommand to itemize terms(e.g. `\underlineitem'), put | 1116 newcommand to itemize terms(e.g. `\underlineitem'), put |
1114 | 1117 |
1115 (setq YaTeX-item-regexp | 1118 (setq YaTeX-item-regexp |
1116 "\\(\\\\\\(sub\\)*item\\)\\|\\(\\\\underlineitem\\)") | 1119 "\\(\\\\\\(sub\\)*item\\)\\|\\(\\\\underlineitem\\)") |
1117 | 1120 |
1118 in your `~/.emacs'. If you are not familiar with regular expression for | 1121 in your `~/.emacs'. If you are not familiar with regular expression |
1119 Emacs-Lisp, name a newcommand for `itemize' beginning with `\item' such as | 1122 for Emacs-Lisp, name a newcommand for `itemize' beginning with |
1120 `\itembf', not `\bfitem'. | 1123 `\item' such as `\itembf', not `\bfitem'. |
1121 | 1124 |
1122 This function reformats the `\item' into `hang-indented' style. For | 1125 This function reformats the `\item' into `hang-indented' style. For |
1123 example: | 1126 example: |
1124 | 1127 |
1125 itemize, enumerate environment: | 1128 itemize, enumerate environment: |
1165 in the main file. YaTeX automatically detects that the current edited | 1168 in the main file. YaTeX automatically detects that the current edited |
1166 text is not in includeonly list and prompts you | 1169 text is not in includeonly list and prompts you |
1167 | 1170 |
1168 A)dd R)eplace %)comment? | 1171 A)dd R)eplace %)comment? |
1169 | 1172 |
1170 in the minibuffer. Type `a' if you want to add the current file name to | 1173 in the minibuffer. Type `a' if you want to add the current file name |
1171 `\includeonly' list, `r' to replace \`includeonly' list with the current | 1174 to `\includeonly' list, `r' to replace \`includeonly' list |
1172 file, and type `%' to comment out the `\includeonly' line. | 1175 with the current file, and type `%' to comment out the |
1176 `\includeonly' line. | |
1173 | 1177 |
1174 | 1178 |
1175 | 1179 |
1176 File: yatexe, Node: What column, Next: Intelligent newline, Prev: Updation of includeonly, Up: Top | 1180 File: yatexe, Node: What column, Next: Intelligent newline, Prev: Updation of includeonly, Up: Top |
1177 | 1181 |
1238 Note that since this function works seeing the contents of the first | 1242 Note that since this function works seeing the contents of the first |
1239 line, please call this after the second line if possible. | 1243 line, please call this after the second line if possible. |
1240 | 1244 |
1241 If you want to apply these trick to other environments, `foo' | 1245 If you want to apply these trick to other environments, `foo' |
1242 environment for example, define the function named | 1246 environment for example, define the function named |
1243 `YaTeX-intelligent-newline-foo' to insert corresponding contents. That | 1247 `YaTeX-intelligent-newline-foo' to insert corresponding contents. |
1244 function will be called at the beginning of the next line after the | 1248 That function will be called at the beginning of the next line after the |
1245 newline is inserted to the current line. Since the function | 1249 newline is inserted to the current line. Since the function |
1246 `YaTeX-indent-line' is designed to indent the current line properly, | 1250 `YaTeX-indent-line' is designed to indent the current line properly, |
1247 calling this function before your code to insert certain contents must be | 1251 calling this function before your code to insert certain contents must be |
1248 useful. See the definition of the function | 1252 useful. See the definition of the function |
1249 `YaTeX-intelligent-newline-itemize' as an example. | 1253 `YaTeX-intelligent-newline-itemize' as an example. |
1412 You can customize YaTeX by setting Emacs-Lisp variables and by making | 1416 You can customize YaTeX by setting Emacs-Lisp variables and by making |
1413 add-in functions. | 1417 add-in functions. |
1414 | 1418 |
1415 * Menu: | 1419 * Menu: |
1416 | 1420 |
1417 * Lisp variables:: | 1421 * Lisp variables:: |
1418 * Add-in functions:: | 1422 * Add-in functions:: |
1419 * Add-in generator:: | 1423 * Add-in generator:: |
1420 | 1424 |
1421 | 1425 |
1422 | 1426 |
1423 File: yatexe, Node: Lisp variables, Next: Add-in functions, Prev: Customizations, Up: Customizations | 1427 File: yatexe, Node: Lisp variables, Next: Add-in functions, Prev: Customizations, Up: Customizations |
1424 | 1428 |
1438 invoked with `C-c Capital-letter' remain valid, if you want to disable | 1442 invoked with `C-c Capital-letter' remain valid, if you want to disable |
1439 those bindings, set that variable to 1 instead of `t'). | 1443 those bindings, set that variable to 1 instead of `t'). |
1440 | 1444 |
1441 * Menu: | 1445 * Menu: |
1442 | 1446 |
1443 * All customizable variables:: | 1447 * All customizable variables:: |
1444 * Sample definitions:: | 1448 * Sample definitions:: |
1445 * Hook variables:: | 1449 * Hook variables:: |
1446 * Hook file:: | 1450 * Hook file:: |
1447 | 1451 |
1448 | 1452 |
1449 | 1453 |
1450 File: yatexe, Node: All customizable variables, Next: Sample definitions, Prev: Lisp variables, Up: Lisp variables | 1454 File: yatexe, Node: All customizable variables, Next: Sample definitions, Prev: Lisp variables, Up: Lisp variables |
1451 | 1455 |
1528 Regexp of LaTeX sectioning command | 1532 Regexp of LaTeX sectioning command |
1529 (`"\\(part\\|chapter\\*?\\|\\(sub\\)*\\(section\\|paragraph\\)\\*?\\)\\b"') | 1533 (`"\\(part\\|chapter\\*?\\|\\(sub\\)*\\(section\\|paragraph\\)\\*?\\)\\b"') |
1530 | 1534 |
1531 -- Variable: YaTeX-fill-inhibit-environments | 1535 -- Variable: YaTeX-fill-inhibit-environments |
1532 Inhibit fill in these environments (`'("tabular" "tabular*" "array" | 1536 Inhibit fill in these environments (`'("tabular" "tabular*" "array" |
1533 "picture" "eqnarray" "eqnarray*" "equation" "math" "displaymath" | 1537 picture" "eqnarray" "eqnarray*" "equation" "math" "displaymath" |
1534 "verbatim" "verbatim*")') | 1538 verbatim" "verbatim*")') |
1535 | 1539 |
1536 -- Variable: YaTeX-uncomment-once | 1540 -- Variable: YaTeX-uncomment-once |
1537 T for deleting all preceding `%' (`nil') | 1541 T for deleting all preceding `%' (`nil') |
1538 | 1542 |
1539 -- Variable: YaTeX-close-paren-always | 1543 -- Variable: YaTeX-close-paren-always |
1575 | 1579 |
1576 -- Variable: YaTeX-hierarchy-ignore-heading-regexp | 1580 -- Variable: YaTeX-hierarchy-ignore-heading-regexp |
1577 `YaTeX-display-hierarchy' searches for sectioning command first, and | 1581 `YaTeX-display-hierarchy' searches for sectioning command first, and |
1578 comment line secondary as a file headings. In latter case, ignore lines | 1582 comment line secondary as a file headings. In latter case, ignore lines |
1579 that match with regular expression of this variable. Default value of | 1583 that match with regular expression of this variable. Default value of |
1580 this variable is RCS header expressions and mode specifying line `-*- xxxx | 1584 this variable is RCS header expressions and mode specifying line `-*- xxxx |
1581 -*'. | 1585 -*'. |
1582 | 1586 |
1583 -- Variable: YaTeX-skip-default-reader | 1587 -- Variable: YaTeX-skip-default-reader |
1584 Non-nil for this variable skips the default argument reader of | 1588 Non-nil for this variable skips the default argument reader of |
1585 section-type command when add-in function for it is not defined | 1589 section-type command when add-in function for it is not defined |
1629 YaTeX tries to search italic, bold fontsets or not (`t' if Emacs-20 | 1633 YaTeX tries to search italic, bold fontsets or not (`t' if Emacs-20 |
1630 or later). This variable is effective only when font-lock is used. | 1634 or later). This variable is effective only when font-lock is used. |
1631 (`(featurep 'hilit19)' | 1635 (`(featurep 'hilit19)' |
1632 | 1636 |
1633 -- Variable: YaTeX-singlecmd-suffix | 1637 -- Variable: YaTeX-singlecmd-suffix |
1634 Suffix which is always inserted after maketitle-type macros. `"{}"' | 1638 Suffix which is always inserted after maketitle-type macros. |
1635 is recommended. | 1639 `"{}"' is recommended. |
1636 | 1640 |
1637 -- Variable: YaTeX-package-alist-private | 1641 -- Variable: YaTeX-package-alist-private |
1638 Alist of LaTeX2e-package name vs. lists of macros in it. Set this | 1642 Alist of LaTeX2e-package name vs. lists of macros in it. Set this |
1639 alist properly and YaTeX automatically check the declaratiion of | 1643 alist properly and YaTeX automatically check the declaratiion of |
1640 `usepackage' for corresponding macro, when you input that macro with | 1644 `usepackage' for corresponding macro, when you input that macro with |
1759 1. Define the function | 1763 1. Define the function |
1760 2. Put the function into `yatexhks.el' | 1764 2. Put the function into `yatexhks.el' |
1761 | 1765 |
1762 * Menu: | 1766 * Menu: |
1763 | 1767 |
1764 * How the add-in function works:: | 1768 * How the add-in function works:: |
1765 * How the function is called:: | 1769 * How the function is called:: |
1766 * Useful functions for creating add-in:: | 1770 * Useful functions for creating add-in:: |
1767 * Contribution:: | 1771 * Contribution:: |
1768 | 1772 |
1769 | 1773 |
1770 | 1774 |
1771 File: yatexe, Node: How the add-in function works, Next: How the function is called, Prev: Add-in functions, Up: Add-in functions | 1775 File: yatexe, Node: How the add-in function works, Next: How the function is called, Prev: Add-in functions, Up: Add-in functions |
1772 | 1776 |
1820 You do set-mark-command at point A and then move to point B. Typing | 1824 You do set-mark-command at point A and then move to point B. Typing |
1821 `[prefix] S' and input `frac' enclose the region like this; | 1825 `[prefix] S' and input `frac' enclose the region like this; |
1822 | 1826 |
1823 \frac{a/c} | 1827 \frac{a/c} |
1824 | 1828 |
1825 Normally, the expression `a/c' is translated to `\frac{a}{c}'. An | 1829 Normally, the expression `a/c' is translated to |
1826 enclosing add-in is useful for modifying `/' to `}{'. | 1830 `\frac{a}{c}'. An enclosing add-in is useful for modifying |
1831 `/' to `}{'. | |
1827 | 1832 |
1828 * Menu: | 1833 * Menu: |
1829 | 1834 |
1830 * Defining option-add-in:: | 1835 * Defining option-add-in:: |
1831 * Defining argument-add-in:: | 1836 * Defining argument-add-in:: |
1832 * Defining enclosing-add-in:: | 1837 * Defining enclosing-add-in:: |
1833 | 1838 |
1834 | 1839 |
1835 | 1840 |
1836 File: yatexe, Node: Defining option-add-in, Next: Defining argument-add-in, Prev: How the add-in function works, Up: How the add-in function works | 1841 File: yatexe, Node: Defining option-add-in, Next: Defining argument-add-in, Prev: How the add-in function works, Up: How the add-in function works |
1837 | 1842 |
1868 minibuffer. Here is the created function considering this. | 1873 minibuffer. Here is the created function considering this. |
1869 | 1874 |
1870 (defun YaTeX::newcommand (n) ;n is argument position | 1875 (defun YaTeX::newcommand (n) ;n is argument position |
1871 (cond | 1876 (cond |
1872 ((= n 1) ;1st argument is macro name | 1877 ((= n 1) ;1st argument is macro name |
1873 (read-string "Command: " "\\")) ;initial input `\' | 1878 (read-string "Command: " "\\")) ;initial input `\' |
1874 ((= n 2) "") ;do nothing when reading arg#2 | 1879 ((= n 2) "") ;do nothing when reading arg#2 |
1875 (t nil))) | 1880 (t nil))) |
1876 | 1881 |
1877 Note that when the `argument add-in' function return `nil', normal | 1882 Note that when the `argument add-in' function return `nil', normal |
1878 argument reader will be called. | 1883 argument reader will be called. |
1896 (defun YaTeX::frac-region (beg end) | 1901 (defun YaTeX::frac-region (beg end) |
1897 (catch 'done | 1902 (catch 'done |
1898 (while (search-forward "/" end t) | 1903 (while (search-forward "/" end t) |
1899 (goto-char (match-beginning 0)) | 1904 (goto-char (match-beginning 0)) |
1900 (if (y-or-n-p "Replace this slash(/) with `}{'") | 1905 (if (y-or-n-p "Replace this slash(/) with `}{'") |
1901 (throw 'done (replace-match "}{"))) | 1906 (throw 'done (replace-match "}{"))) |
1902 (goto-char (match-end 0))))) | 1907 (goto-char (match-end 0))))) |
1903 | 1908 |
1904 | 1909 |
1905 | 1910 |
1906 File: yatexe, Node: How the function is called, Next: Useful functions for creating add-in, Prev: How the add-in function works, Up: Add-in functions | 1911 File: yatexe, Node: How the function is called, Next: Useful functions for creating add-in, Prev: How the add-in function works, Up: Add-in functions |
1931 `[F]' | 1936 `[F]' |
1932 YaTeX:read-position | 1937 YaTeX:read-position |
1933 `[A]' | 1938 `[A]' |
1934 Character list which can show up in the brackets | 1939 Character list which can show up in the brackets |
1935 `[D]' | 1940 `[D]' |
1936 Return the location specifier such as `[htb]'. When nothing is | 1941 Return the location specifier such as `[htb]'. When |
1937 entered, omit [] itself. If the possible characters are "htbp", call | 1942 nothing is entered, omit [] itself. If the possible characters |
1938 this function as `(YaTeX:read-position "htbp")' | 1943 are "htbp", call this function as |
1944 `(YaTeX:read-position "htbp")' | |
1939 | 1945 |
1940 `[F]' | 1946 `[F]' |
1941 YaTeX:read-coordinates | 1947 YaTeX:read-coordinates |
1942 `[A]' | 1948 `[A]' |
1943 Base prompt, X-axis prompt, Y-axis prompt (each optional) | 1949 Base prompt, X-axis prompt, Y-axis prompt (each optional) |
1944 `[D]' | 1950 `[D]' |
1945 Read the coordinates with the prompt "BasePrompt X-axisPrompt:" for | 1951 Read the coordinates with the prompt "BasePrompt X-axisPrompt:" for |
1946 X-axis, "BasePrompt Y-axisPrompt:" for Y-axis, and return it in the | 1952 X-axis, "BasePrompt Y-axisPrompt:" for Y-axis, and return it in the form |
1947 form of "(X,Y)". The default prompts are `Dimension', `X', `Y' | 1953 of "(X,Y)". The default prompts are `Dimension', `X', |
1948 respectively. | 1954 `Y' respectively. |
1949 | 1955 |
1950 `[F]' | 1956 `[F]' |
1951 YaTeX:check-completion-type | 1957 YaTeX:check-completion-type |
1952 `[A]' | 1958 `[A]' |
1953 One of the symbols: 'begin, 'section, or 'maketitle | 1959 One of the symbols: 'begin, 'section, or 'maketitle |
1997 Simple generator | 2003 Simple generator |
1998 ---------------- | 2004 ---------------- |
1999 | 2005 |
2000 The latter generator is invoked by the next sequence. `M-x | 2006 The latter generator is invoked by the next sequence. `M-x |
2001 YaTeX-generate-simple' This generator can make both "option add-in" and | 2007 YaTeX-generate-simple' This generator can make both "option add-in" and |
2002 "argument add-in" (*refer the section add-in functions* *Note How the | 2008 argument add-in" (*refer the section add-in functions* *Note How the |
2003 add-in function works::), whereas `YaTeX-generate' cannot make "argument | 2009 add-in function works::), whereas `YaTeX-generate' cannot make "argument |
2004 addin". | 2010 addin". |
2005 | 2011 |
2006 For example, assume you have the LaTeX command as follows. | 2012 For example, assume you have the LaTeX command as follows. |
2007 | 2013 |
2008 \epsinput[t](250,50){hoge.eps}{plain}{Picture of foo} | 2014 \epsinput[t](250,50){hoge.eps}{plain}{Picture of foo} |
2009 (A) (B) (1) (2) (3) | 2015 (A) (B) (1) (2) (3) |
2010 (A)Optional parameter to specify the position | 2016 (A)Optional parameter to specify the position |
2011 One of t(top), b(bottom), l(left), r(right) | 2017 One of t(top), b(bottom), l(left), r(right) |
2012 (B)Maximum size of frame | 2018 (B)Maximum size of frame |
2013 (1)1st argument is filename of EPS file | 2019 (1)1st argument is filename of EPS file |
2014 (2)2nd argument indicates | 2020 (2)2nd argument indicates |
2015 plain do nothing | 2021 plain do nothing |
2016 frame make frame around image | 2022 frame make frame around image |
2017 dframe make double-frame around image | 2023 dframe make double-frame around image |
2018 for included EPS file. | 2024 for included EPS file. |
2019 (3)Caption for the picture | 2025 (3)Caption for the picture |
2020 | 2026 |
2021 Now get start with generation. Typing `M-x YaTeX-generate-simple' | 2027 Now get start with generation. Typing `M-x YaTeX-generate-simple' |
2022 brings the prompt: | 2028 brings the prompt: |
2023 (O)ption? (A)rgument? | 2029 (O)ption? (A)rgument? |
2024 | 2030 |
2059 Since (A) is the optional argument to specify the location of included | 2065 Since (A) is the optional argument to specify the location of included |
2060 EPS file, the completion style is `Position', and the possible characters | 2066 EPS file, the completion style is `Position', and the possible characters |
2061 are t, b, l, and r. To tell these information to generator, operate as | 2067 are t, b, l, and r. To tell these information to generator, operate as |
2062 follows. | 2068 follows. |
2063 | 2069 |
2064 Read type(1).... p | 2070 Read type(1).... p |
2065 Acceptable characters: tblr RET | 2071 Acceptable characters: tblr RET |
2066 | 2072 |
2067 (B) is coordinate. So its completion style is coOrd. We want a prompt | 2073 (B) is coordinate. So its completion style is coOrd. We want a prompt |
2068 meaning "Maximum size" when completion. | 2074 meaning "Maximum size" when completion. |
2069 | 2075 |
2106 Prompt for argument#2 Include style RET | 2112 Prompt for argument#2 Include style RET |
2107 | 2113 |
2108 Then all the candidates ready to be read. Type single RET after | 2114 Then all the candidates ready to be read. Type single RET after |
2109 entering all. | 2115 entering all. |
2110 | 2116 |
2111 Item[1](RET to exit): plain RET | 2117 Item[1](RET to exit): plain RET |
2112 Item[2](RET to exit): frame RET | 2118 Item[2](RET to exit): frame RET |
2113 Item[3](RET to exit): dframe RET | 2119 Item[3](RET to exit): dframe RET |
2114 Item[4](RET to exit): RET | 2120 Item[4](RET to exit): RET |
2115 | 2121 |
2116 The following prompt asks whether the entered string must belong to | 2122 The following prompt asks whether the entered string must belong to |
2117 candidates or not. In this case, since the argument must be one of | 2123 candidates or not. In this case, since the argument must be one of |
2118 `plain', `frame', and `dframe', type `y'. | 2124 `plain', `frame', and `dframe', type `y'. |
2119 | 2125 |
2179 | 2185 |
2180 HIROSE Yuuji | 2186 HIROSE Yuuji |
2181 | 2187 |
2182 Tag table: | 2188 Tag table: |
2183 Node: Top256 | 2189 Node: Top256 |
2184 Node: What is YaTeX?1597 | 2190 Node: What is YaTeX?1583 |
2185 Node: Main features1970 | 2191 Node: Main features1956 |
2186 Node: Installation3499 | 2192 Node: Installation3485 |
2187 Node: Typesetting4276 | 2193 Node: Typesetting4262 |
2188 Node: Calling typesetter5406 | 2194 Node: Calling typesetter5357 |
2189 Node: Calling previewer7610 | 2195 Node: Calling previewer7561 |
2190 Node: Printing out7971 | 2196 Node: Printing out7922 |
2191 Node: %#notation8263 | 2197 Node: %#notation8214 |
2192 Node: Changing typesetter8681 | 2198 Node: Changing typesetter8585 |
2193 Node: Splitting input files9045 | 2199 Node: Splitting input files8949 |
2194 Node: Static region for typesetting10470 | 2200 Node: Static region for typesetting10374 |
2195 Node: Lpr format11599 | 2201 Node: Lpr format11503 |
2196 Node: Controlling which command to invoke12672 | 2202 Node: Controlling which command to invoke12576 |
2197 Node: Editing %# notation13265 | 2203 Node: Editing %# notation13163 |
2198 Node: Completion13809 | 2204 Node: Completion13707 |
2199 Node: Begin-type completion14369 | 2205 Node: Begin-type completion14196 |
2200 Node: Section-type completion17412 | 2206 Node: Section-type completion17238 |
2201 Node: view-sectioning19847 | 2207 Node: view-sectioning19659 |
2202 Node: Large-type completion21427 | 2208 Node: Large-type completion21239 |
2203 Node: Maketitle-type completion22158 | 2209 Node: Maketitle-type completion21969 |
2204 Node: Arbitrary completion22710 | 2210 Node: Arbitrary completion22521 |
2205 Node: End completion23100 | 2211 Node: End completion22911 |
2206 Node: Accent completion23570 | 2212 Node: Accent completion23380 |
2207 Node: Image completion24187 | 2213 Node: Image completion23997 |
2208 Node: Greek letters completion26444 | 2214 Node: Greek letters completion26252 |
2209 Node: Local dictionaries27171 | 2215 Node: Local dictionaries26979 |
2210 Node: Commenting out28108 | 2216 Node: Commenting out27916 |
2211 Node: Cursor jump29567 | 2217 Node: Cursor jump29375 |
2212 Node: Jump to corresponding object29879 | 2218 Node: Jump to corresponding object29666 |
2213 Node: Invoking image processor31280 | 2219 Node: Invoking image processor31066 |
2214 Node: Jump to main file32623 | 2220 Node: Jump to main file32409 |
2215 Node: Jumping around the environment32988 | 2221 Node: Jumping around the environment32775 |
2216 Node: Jumping to last completion position33406 | 2222 Node: Jumping to last completion position33193 |
2217 Node: Changing and Deleting33915 | 2223 Node: Changing and Deleting33702 |
2218 Node: Changing LaTeX commands34307 | 2224 Node: Changing LaTeX commands34083 |
2219 Node: Killing LaTeX commands35484 | 2225 Node: Killing LaTeX commands35260 |
2220 Node: Filling36669 | 2226 Node: Filling36445 |
2221 Node: Updation of includeonly38520 | 2227 Node: Updation of includeonly38300 |
2222 Node: What column39317 | 2228 Node: What column39097 |
2223 Node: Intelligent newline40402 | 2229 Node: Intelligent newline40182 |
2224 Node: Usepackage checker42056 | 2230 Node: Usepackage checker41835 |
2225 Node: Online help42647 | 2231 Node: Online help42426 |
2226 Node: Browsing file hierarchy44322 | 2232 Node: Browsing file hierarchy44101 |
2227 Node: Cooperation with other packages46059 | 2233 Node: Cooperation with other packages45838 |
2228 Node: Customizations46764 | 2234 Node: Customizations46543 |
2229 Node: Lisp variables47098 | 2235 Node: Lisp variables46839 |
2230 Node: All customizable variables48102 | 2236 Node: All customizable variables47798 |
2231 Node: Sample definitions57901 | 2237 Node: Sample definitions57593 |
2232 Node: Hook variables58414 | 2238 Node: Hook variables58106 |
2233 Node: Hook file59118 | 2239 Node: Hook file58810 |
2234 Node: Add-in functions59457 | 2240 Node: Add-in functions59149 |
2235 Node: How the add-in function works60317 | 2241 Node: How the add-in function works59987 |
2236 Node: Defining option-add-in62516 | 2242 Node: Defining option-add-in62173 |
2237 Node: Defining argument-add-in63238 | 2243 Node: Defining argument-add-in62895 |
2238 Node: Defining enclosing-add-in64120 | 2244 Node: Defining enclosing-add-in63776 |
2239 Node: How the function is called64974 | 2245 Node: How the function is called64632 |
2240 Node: Useful functions for creating add-in65650 | 2246 Node: Useful functions for creating add-in65308 |
2241 Node: Contribution67055 | 2247 Node: Contribution66718 |
2242 Node: Add-in generator67329 | 2248 Node: Add-in generator66992 |
2243 Node: Etcetera72701 | 2249 Node: Etcetera72452 |
2244 Node: Copying73306 | 2250 Node: Copying73057 |
2245 | 2251 |
2246 End tag table | 2252 End tag table |