yatex
view help/YATEXHLP.eng @ 79:0734be649cb8
Do not care file-coding-system when YaTeX-kanji-code is nil.
New completion yatexpkg.el is introduced.
| author | yuuji |
|---|---|
| date | Thu, 25 Dec 2003 04:10:32 +0000 |
| parents | 1b172d26b55e |
| children | 9b4354af748c |
line source
1 %%%
2 %%% YaTeX-LaTeX Help File(c)HIROSE Yuuji [yuuji@yatex.org]
3 %%% You can translate this file for any device other than YaTeX via
4 %%% any filter program. But it is not allowed to remove copyright
5 %%% notice and any existing dictionary entiries.
6 %%%
8 textfloatsep
9 \addtolength{\textfloatsep}{LENGTH}
10 Length between the text and a float at the top or bottom of page
12 floatsep
13 \addtolength{\floatsep}{LENGTH}
14 Length between two floats
16 oddsidemargin
17 \setlength{\oddsidemargin}{LENGTH}
18 Length between text and a line 1 inch from the left of page, on the
19 right page
22 pagestyle
23 \pagestyle{STYLE}
24 Determines header and footer styles on output page. There are the
25 following styles
26 plain Standard style. Page number only in footer.
27 empty No headers or footers are output.
28 headings Puts page number and headings according to section in header.
29 No footer is output.
30 myheadings User defines what goes into headings using \markbpth and \markright
32 thispagestyle
33 \thispagestyle{STYLE}
34 Determines the STYLE for the current page only
36 pagenumbering
37 \pagenumbering{STYLE}
38 Determines the STYLE of page numbers. Type of STYLEs are,
39 arabic arabic numerals
40 alph lowercase alphabets
41 Alph uppercase alphabets
42 roman lowercase roman numerals
43 Roman uppercase roman numerals
45 shortstack
46 \shortstack[POSITION]{TEXT\\TO BE\\STACKED}
47 Stack and display contents within {}, separated by \\.
48 Possible [POSITION]s are, l(left), c(center), r(right).
50 newlength
51 \newlength{NAME}
52 Declare NAME as a length command.
54 addtolength
55 \addtolength{LENGTH COMMAND}{VALUE}
56 Adds VALUE to LENGTH COMMAND.
57 See \setlength for major style parameters.
59 setlength
60 \setlength{LENGTH COMMAND}{VALUE}
61 Set the value of LENGTH COMMAND to VALUE.
62 Major style parameters are:
63 (Style parameters must be changed in the preamble)
64 \evensidemargin \footheight \footskip \headheight
65 \headsep \marginparsep \marginparwidth \oddsidemargin
66 \textheight \textwidth \topmargin \topskip
67 \parindent \baselineskip \baselinestretch \parskip
68 \columnsep \columnseprule \mathindent
70 settowidth{\NAME}{TEXT}
71 Set the value of \NAME to the width of \hbox{TEXT}.
73 evensidemargin
74 \setlength{\evensidemargin}{LENGTH}
75 Length between body and a line 1 inch from the left of page, on the
76 left page.
78 footheight
79 \setlength{\footheight}{LENGTH}
80 Height of footer.
82 footskip
83 \setlength{\footskip}{LENGTH}
84 Length between bottom of body and footer.
86 headheight
87 \addtolength{\headheight}{LENGTH}
88 Height of header.
90 headsep
91 \setlength{\headsep}{LENGTH}
92 Length between top of body and header.
94 marginparsep
95 \addtolength{\marginparsep}{LENGTH}
96 Length between the body and marginal notes
98 marginparwidth
99 \addtolength{\marginparwidth}{LENGTH}
100 Width of marginal notes.
102 oddsidemargin
103 \addtolength{\oddsidemargin}{LENGTH}
104 Length between body and a line 1 inch from the left of page, on the
105 right page.
108 textheight
109 \addtolength{\textheight}{LENGTH}
110 Height of text.
112 textwidth
113 \addtolength{\textwidth}{LENGTH}
114 Width of body.
116 topmargin
117 \addtolength{\topmargin}{LENGTH}
118 Length between the header and a line one inch from the top of the page.
120 topskip
121 \addtolength{\topskip}{LENGTH}
122 Length between top of the body to the first line of the text.
124 parindent
125 \setlength{\parindent}{LENGTH}
126 Width of indentation at the beginning of a paragraph.
128 linewidth
129 \addtolength{\linewidth}{LENGTH}
130 Width of lines.
132 baselineskip
133 \addtolength{baselineskip}{LENGTH}
134 Minimum height between baselines (bottom of a line).
136 baselinestretch
137 \renewcommand{baselinestretch}{1.5}
138 Value to multiply \baselineskip. (default is 1)
139 (* Redefine using \renewcommand. Don't use \setlength.
141 parskip
142 \addtolength{\parskip}{LENGTH}
143 Vertical space before a paragraph.
145 columnsep
146 \addtolength{\columnsep}{LENGTH}
147 Width between columns in a two column environment.
149 columnseprule
150 \addtolength{\columnseprule}{LENGTH}
151 Width of ruler to separate columns in a two column environment.
152 (default is 0pt)
154 columnwidth
155 \addtolength{\columnwidth}{LENGTH}
156 (\textwidth - \columnsep)/2 in a two column environment.
157 Otherwise, equal to \textwidth.
159 mathindent
160 \addtolength{mathindent}{LENGTH}
161 Width of indentation of a equation from the left margin, when fleqn is
162 defined as style option.
164 LaTeX
165 \LaTeX
166 Display \LaTeX logo. Definition of \LaTeX is;
167 \def\LaTeX{{\rm L\kern-.36em\raise.3ex\hbox{\sc a}\kern-.15em
168 T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX}}
170 fragile
171 ** LaTeX term **
172 Any command which expanded result changes by an argument.
173 Opposite is a robust command.
175 robust
176 ** LaTeX term **
177 Commands which expanded results are always the same.
178 Font type/size selection commands, length commands, and most commands
179 used within math mode is robust.
180 (maketitle type commands that don't take any arguments)
182 protect
183 \protect `a fragile command'
184 Commands that the result changes according to it's arguments are
185 called "fragile commands". When an argument is referenced in more
186 than one place, the command is said to "take a moving argument".
187 chapter and caption, whose argument will be used in the table of
188 contents, or an @ in an tabular/array environment are examples.
190 When a "fragile command" is used in a "moving argument", it must be
191 preceded by a \protect. Following is an example.
193 \newcommand{\thissystem}[1]{YaTeX version #1}
194 \chapter{About \protect \thissystem{1.50}}
196 newcommand
197 \newcommand{\NAME}[ARGS]{DEF}
198 Define a macro \NAME as DEF, taking ARGS number of arguments. The nth
199 argument will be referred as #n in the definition.
200 If used as
201 \newcommand{\foo}[1]{\underline{#1}}
202 \foo{bar} will be expanded to \underline{bar}. When a font selection
203 command is used as
204 \newcommand{\foo}[1]{\bf #1}
205 \foo{bar} will be expanded as \bf bar in the text, so, it must be used as
206 \newcommand{\foo}[1]{{\bf #1}}
208 If NAME is already defined as a macro, it will return an error. To
209 redefine, use \renewcommand.
211 renewcommand
212 \renewcommand{\NAME}[ARGS]{DEF}
213 Redefine an already defined command.
214 <refer newcommand>
216 newenvironment
217 \newenvironment{NAME}[ARGS]{DEF1}{DEF2}
218 Define a new environment.
219 \begin{NAME} will be replaced by DEF1 and \end{NAME} will be replaced
220 by DEF2. Same as
221 \newcommand{\NAME}{DEF1} \def{\end{\NAME}}{DEF2}
223 renewenvironment
224 \renewenvironment{NAME}[ARGS]{DEF1}{DEF2}
225 Redefine an environment NAME that already exists.
226 <refer newenvironment>
228 typeout
229 \typeout{MESSAGE}
230 Output MESSAGE to the terminal while typesetting.
232 typein
233 \typein{MESSAGE} \typein[\MACRO]{MESSAGE}
234 Output MESSAGE to terminal and execute the input.
235 In the second form, \MACRO will be defined as the input.
237 par
238 \par
239 Used to separate paragraphs. Same as a blank line.
241 everypar
242 \everypar
243 RTFM
245 nopagebreak
246 \nopagebreak[i] (i = 0,1,2,3,4)
247 Prevents pages to be broken by the strength of i. (default is 4)
249 pagebreak
250 \pagebreak[i] (i = 0,1,2,3,4)
251 Forces pages to be broken by the strength of i. (default is 4)
253 linebreak
254 \linebreak[i] (i = 0,1,2,3,4)
255 Forces lines to be broken by the strength of i. (default is 4)
257 nolinebreak
258 \nolinebreak[i] (i = 0,1,2,3,4)
259 Prevents lines to be broken by the strength of i. (default is 4)
261 samepage
262 \samepage
263 Prevents page to be broken.
264 RTFM
266 obeycr
267 \obeycr
268 Define <CR> as \\. see \restorecr
270 restorecr
271 \restorecr
272 Restore <CR>'s definition changed by \obeycr.
274 \
275 \\ \\[LENGTH]
277 Breaks a line at any given point. Same as \newline if used within a
278 paragraph. If an option argument LENGTH is given, vertical space to
279 next line will be \vspace{LENGTH}.
281 addvspace
282 \addvspace{SKIP}
283 Adds space equal to SKIP to vertical space. If more than one values
284 are given as \addvspace{S1} \addvspace{S2}, it will be the same as
285 \addvspace{the larger of S1, S2}.
287 vspace
288 \vspace{LENGTH} \vspace*{LENGTH}
289 Adds vertical space of LENGTH.
290 \vspace* will add space at any given position, but \vspace will not
291 add at beginning or end of a page.
293 vspace*
294 \vspace{LENGTH} \vspace*{LENGTH}
295 Adds vertical space of LENGTH.
296 \vspace* will add space at any given position, but \vspace will not
297 add at beginning or end of a page.
299 hspace
300 \hspace{LENGTH} \hspace*{LENGTH}
301 Adds horizontal space of LENGTH.
302 \hspace* will add space at any given position, but \hspace will not add
303 at beginning or end of a line.
305 hspace*
306 \hspace{LENGTH} \hspace*{LENGTH}
307 Adds horizontal space of LENGTH.
308 \hspace* will add space at any given position, but \hspace will not add
309 at beginning or end of a line.
311 smallskip
312 \smallskip
313 Put a small vertical space.
314 \def\smallskip{\vspace\smallskipamount}
316 medskip
317 \medskip
318 Put a medium vertical space.
319 \def\medskip{\vspace\medskipamount}
321 bigskip
322 \bigskip
323 Put a big vertical skip.
324 \def\bigskip{\vspace\bigskipamount}
326 ,
327 \,
328 Opens a thin space. Can be used in paragraph mode, LR mode, or math mode.
329 Used to write a quote within a quote.
330 example: ``\,`Foo', he said.''
331 Spaces that can be used in math mode are:
332 \: medium space
333 \! negative and thin space
334 \; thick space
336 :
337 $\:$
338 Medium space. Math mode only.
340 !
341 $\!$
342 Negative thin space. Math mode only.
344 ;
345 $\;$
346 Thick space. Math mode only.
348 whiledo{TEST}{BODY}
349 Repeat BODY while TEST is true.
351 nofiles
352 \nofiles
353 If \nofiles is in the preamble, .aux, .idx, .lof, .lot, .toc files will
354 not be made.
356 includeonly
357 \includeonly{sub1} \includeonly{sub1,sub3}
358 Appoints actual files to be read and processed by \include{}. (.tex can
359 be suppressed)
360 Files not given in the argument list of \includeonly will not be
361 processed at all. If the file has been processed before, it will be
362 treated as if there were no changes from then.
364 include
365 \include{FILE}
366 Same as
367 \clearpage \input{FILE} \clearpage
369 input
370 \input{FILE}
371 Process as if FILE.tex has been inserted at that point.
373 setcounter
374 \setcounter{FOO}{VAL}
375 Set counter FOO's value to VAL.
377 addtocounter
378 \addtocounter{FOO}{VAL}
379 Add value VAL to counter FOO.
381 newcounter
382 \newcounter{COUNTER}[OLDCTR]
383 Defines a new counter COUNTER.
384 If an optional argument OLDCTR is given, COUNTER's value will be reset
385 every time OLDCTR's value is changed by \stepcounter or \addtocounter.
387 value
388 \value{COUNTER}
389 Returns value of COUNTER. Must not be preceded by \protect.
391 stepcounter
392 \stepcounter{FOO}
393 Increments value of counter FOO. Also resets any counter dependent to FOO.
395 refstepcounter
396 \refstepcounter{FOO}
397 Increments value of counter FOO. Also resets any counter dependent to
398 FOO. Defers with \stepcounter as; if \label{hoge} follows immediately
399 after \refstepcounter{FOO}, \ref{hoge}'s value will be set to \value{FOO}.
401 arabic
402 \arabic{COUNTER}
403 Output COUNTER's value in arabic numerals.
405 roman
406 \roman{COUNTER}
407 Output COUNTER's value in lower case roman numerals.
409 Roman
410 \Roman{COUNTER}
411 Output COUNTER's value in upper case roman numerals.
413 alph
414 \alph{COUNTER}
415 Output COUNTER's value in lower case alphabet.
417 Alph
418 \Alph{COUNTER}
419 Output COUNTER's value in upper case alphabet.
421 fnsymbol
422 \fnsymbol{COUNTER}
423 Output COUNTER's value in footnote symbols (1 = *, 2 = \dagger, ...).
424 Math mode only.
426 label
427 \label{LABEL}
428 Set value of LABEL to \ref VALUE.
429 This value is referred by \ref{VALUE}. \pageref{LABEL} refers to the
430 page number \label{LABEL} exists.
431 ``\ref VALUEs'' are, section commands as \section, \item commands within
432 an enumerate environment, values set by a theorem environment. For
433 example, immediately after a \item of a enumerate environment, the item
434 number will be the ``\ref VALUE''. \label{LABEL} will set the item
435 number to LABEL.
437 ref
438 \ref{LABEL}
439 Refer to LABEL's value set by \label{LABEL}.
440 Examples of values returned are; page numbers for LABELs set in the main
441 text, table numbers for LABELs set in a table, and the item number for
442 LABELs set in an item of the enumerate environment.
444 pageref
445 pageref{LABEL}
446 Refer to the page number where \label{LABEL} exists.
448 (
449 \( EQUATION \)
450 Produce an in-text equation.
451 Same as
452 \begin{math} EQUATION \end{math}
453 \( and \) are fragile.
455 )
456 \( x^2 = 4 \)
457 Produce an in-text equation.
458 Same as
459 \begin{math} EQUATION \end{math}
460 \( and \) are fragile.
462 [
463 \[ EQUATION \]
464 Produce an equation in display mode.
465 Same as
466 \begin{displaymath} EQUATION \end{displaymath}
467 \[ and \] are fragile.
469 )
470 \[ EQUATION \]
471 Produce an equation in display mode.
472 Same as
473 \begin{displaymath} EQUATION \end{displaymath}
474 \[ and \] are fragile.
476 equation
477 \begin{equation} EQUATION \end{equation}
478 Produce a numbered equation in displaymath mode.
480 eqnarray
481 \begin{eqnarray} EQNS \end{eqnarray}
482 Produce equations aligned in three columns. The columns are separated by
483 & as ``left member & sign & right member''. For example,
484 \begin{eqnarray}
485 3x + 2y & = & 4 \\
486 x - 4y & = & -5
487 \end{eqnarray}
489 eqnarray*
490 \begin{eqnarray*} EQNS \end{eqnarray*}
491 Same as eqnarray, except no equation numbers are produced.
493 frac
494 \frac{NUMER}{DENOM}
495 Produce a fraction as
496 NUMER
497 ------
498 DENOM
499 Same as {NUMER \over DENOM}
501 sqrt
502 \sqrt[N]{EQUATION}
503 Produces the Nth power of EQUATION. Gives a square root if [N] is not given.
505 lefteqn
506 \lefteqn{EQUATION}
507 In display math mode, presume EQUATION has zero width and print it flush left.
508 Used in eqnarray environment when the left member is too long and needs
509 folding.
510 \begin{eqnarray}
511 \lefteqn{a_1 + a_2 + \cdots + a_n =} \\
512 & & a_1 + b_1 + \cdots + z_1 + \\
513 & & b_2 + c+2 + \cdost + z_2
514 \end{eqnarray}
516 center
517 \begin{center} TEXT \end{center}
518 Center TEXT. Each line must be separated by \\.
519 <refer \centering>
521 flushright
522 \begin{flushright} TEXT \end{flushright}
523 Align end of each line with right margin. Each line must be separated by \\.
524 <refer \raggedright>
526 flushleft
527 \begin{flushleft} TEXT \end{flushleft}
528 Align start of each line with left margin. \\ can be given to decide
529 point of line break. Otherwise lines will be broken at an appropriate
530 length.
531 <refer \raggedleft>
533 centering
534 \centering
535 Produce a centered paragraph.
536 Declared at the beginning of a table/figura environment, it will center
537 until the end of the environment.
539 raggedright
540 \raggedright
541 Produce flush-left paragraphs.
543 raggedleft
544 \raggedleft
545 Produce flush-right paragraphs.
547 raggedbottom
548 \raggedbottom
549 Allow height of each page to vary.
550 Declared in the preamble.
551 <refer \flushbottom>
553 flushbottom
554 \flushbottom
555 Make all text pages the same height.
556 Declared in the preamble.
557 <refer \raggedbottom>
559 sloppy
560 \sloppy
561 Always breaks the line at the right-hand margin, but allows too much
562 space between words.
563 <refer \fussy>
565 fussy
566 \fussy
567 Return to normal line breaking.
568 <refer \sloppy>
570 sloppypar
571 \begin{sloppypar} PARAGRAPH \end{sloppypar}
572 Produce PARAGRAPH in \sloppy.
573 <refer \sloppy>
575 verbatim
576 \begin{verbatim} ... \end{verbatim}
577 The verbatim environment uses the fixed-width \tt font, turns blanks into
578 spaces, starts a new line for each carriage return (or sequence of
579 consecutive carriage returns), and interprets EVERY character literally.
580 I.e., all special characters \, {, $, etc. are \catcode'd to 'other'.
582 verbatim*
583 \begin{verbatim*} ... \end{verbatim*}
584 The verbatim* environment is the same to verbatim, except that spaces
585 print as the TeXbook's space character instead of as blank spaces.
586 <refer verbatim>
588 list
589 \begin{list}{LABEL}{PARAMETER} ... \end{list}
590 Enter list environment. Each \item will be listed with an indent.
591 First argument gives the default label when \item's optional argument is
592 omitted. Second argument gives parameters to be processed for each item.
593 example:
594 \begin{list}%
595 {$\diamond$}
596 {\addtolength{\leftmargin}{4em}}
597 \item First argument is the default label when \verb|\item|'s optional
598 argument is given.
599 \item Second argument will be processed for each item.
600 \item[*] If a optional argument is given such as this, it will be the label.
601 \end{list}
603 Variables to control the list environment are as follow; (default value)
604 horizontal:
605 <refer variables to control list environment>
607 variables to control list environment
608 \labelwidth width of label
609 \labelsep space between right of label and text of first item
610 \leftmargin left margin within list environment
611 \rightmargin right margin within list environment (0pt)
612 \itemindent width of indent preceding item (0pt)
613 \linewidth width of line
614 \listparindent indent for each paragraph (except first paragraph with \item)
615 (0pt)
617 vertical:
618 \topsep space between last paragraph before list environment and
619 first item
620 \partopsep space added to \topsep when starting a new paragraph in list
621 environment
622 \itemsep space between successive items
623 \parsep space between paragraphs within the same item
625 itemize
626 \begin{itemize} \item ITEM1 ... \item ITEMn \end{itemize}
627 Produce a bulleted list.
628 Can be nested to four levels.
629 ``bullets'' shown at top of each item of the four levels are controlled
630 by \labelitemi, \labelitemii, \labelitemiii, \labelitemiv.
632 Variables to control the itemize environment are;
633 <refer variables to control list environment>
635 enumerate
636 \begin{enumerate} \item ITEM1 ... \item ITEMn \end{enumerate}
637 Produce a numbered list.
638 Can be nested to four levels.
639 Numbers for items on each level are held in enumi, enumii, enumiii, enumiv.
640 Each item's label are produced by \labelenumi, ..., \labelenumiv.
641 \p@enumN\theenumN will set \ref's value. (N is the depth of level.
642 refer \ref for value of \ref)
643 For example, if declared
644 \def\theenumii{\alph{enumii}}
645 \def\p@enumii{\theenumi\theenumii}
646 \def\labelenumii{(\theenumii)}
647 \ref's value will be 3a.
649 Variables to control enumerate environment are,
650 <refer variables to control list environment>
652 item
653 \item \item[LABEL]
654 Start an item in itemize, enumerate, description environment.
655 Output LABEL if [LABEL] is given.
657 description
658 \begin{description} \item[LABEL] CONTENTS ... \end{description}
659 Produce [LABEL] as a label.
661 subitem
662 \subitem ITEM
663 Define a subitem.
665 subsubitem
666 \subsubitem ITEM
667 Define a subsubitem.
669 makebox
670 \makebox[WID][POS]{OBJECT} \makebox(X,Y)[POS]{OBJECT}
671 First form will place OBJECT at position POS and width WID in a \box.
672 For POS, object will be placed flush-left if l, flush-right if r, and
673 centered if nothing is given
674 In the second form, object will be placed in a \hbox sized (X,Y) (in
675 \unitlength) within a picture environment. POS is the same as the first form.
677 mbox
678 \mbox{OBJECT}
679 Same as \makebox{OBJECT}.
681 newsavebox
682 \newsavebox{\CMD}
683 Define a new box saving command. \CMD is used in a \savebox command to
684 save boxes. Commands defined by \newsavebox are always global.
686 savebox
687 \savebox{\CMD}{TEXT}
688 Save results of TEXT in \CMD to be boxed.
689 TEXT is the same as the argument of \makebox, but the results of
690 processing TEXT is not displayed in-place. Boxes processed by
691 \usebox{\CMD} will be placed.
693 sbox
694 \sbox{\CMD}{TEXT}
695 Same as \savebox. \sbox is robust, and \savebox is fragile.
697 framebox
698 \framebox{OBJECT}
699 Do the same thing as \makebox with a frame.
700 The frame's width and space between the object are decided by \framerule
701 and \framesep. If used as \framebox(X,Y){OBJECT} in a picture
702 environment, width of frame will be dependant to the picture
703 environment's line width, and space between the object and frame can not
704 be opened.
706 fbox
707 \fbox{OBJECT}
708 Same as \framebox{OBJECT}.
709 \fbox is robust, \framebox fragile.
711 parbox
712 \parbox[POS]{WIDTH}{TEXT}
713 Make a box of width WIDTH using TEXT. The box's position by POS is;
714 c : centering (default)
715 b : bottom of box matches present text
716 t : top of box matches present text
718 In \parbox, parameters will be reset as;
719 \parskip = 0pt
720 \linewidth = \hsize
721 \@totalleftmargin = 0pt
722 \leftskip = 0pt
723 \rightskip = 0pt
724 \@rightskip = 0pt
725 \parfillskip = 0pt plus 1fil
726 \lineskip = \normallineskip
727 \baselineskip = \normalbaselineskip
729 minipage
730 \begin{minipage}[pos]{WIDTH} TEXT \end{minipage}
731 Make a box of width WIDTH using TEXT as \parbox. The box's position by
732 POS is;
733 c : centering (default)
734 b : bottom of box matches present text
735 t : top of box matches present text
736 TEXT will be processed as a normal paragraph, differing from \parbox.
738 rule
739 \rule[RAISED]{WIDTH}{HEIGHT}
740 Make a rule of WIDTH x HEIGHT. If RAISED is given, will be raised that
741 amount.
743 underline
744 \underline{TEXT}
745 Underline TEXT.
747 raisebox
748 \raisebox{DISTANCE}[HEIGHT][DEPTH]{BOX}
749 Raise BOX by DISTANCE.
750 If HEIGHT and DEPTH are given, TeX will take it as the height and depth
751 of the box.
752 (see TeXBook for more info)
754 tabbing
755 \begin{tabbing} \= text1.1 \= text1.2 \\ \> text2.1 \> text2.2 \end{tabbing}
756 Creates an environment of aligned columns (nesting allowed). For example,
757 \begin{tabbing}
758 \= ITEM1 \hspace*{2em} \= ITEM2 \hspace*{3em} \= ITEM3 \\
759 \> aabbcc \> ddeeff \> gghhii \+ \\
760 \> jjkkll \> mmnnoo \\
761 \> ppqqrr \- \\
762 \> ssttuu \> vvwwxx \> yyzzzz
763 \end{tabbing}
764 will be processed with three tab stops as,
765 (1st item) (2nd item) (3rd item)
766 aabbcc ddeeff gghhii
767 jjkkll mmnnoo
768 ppqqrr
769 ssttuu vvwwxx yyzzzz
770 \2em/ \3em/
771 Commands to control the tabbing environment are; (n starts from 1)
772 \= Sets the nth tab stop position to the current position and increment
773 the tab counter (n) by 1.
774 \\ Start a new line and reset the tab counter (n=1)
775 \> Set the position to the nth tab stop and increment the tab counter by 1.
776 \+ Add 1 to the next line's tab counter's initial value. If written as
777 \+ \\, the next line's \> will give the position of the second tab
778 stop. Multiple \+ will accumulate tab counter's initial value.
780 \- Reverse of \+. Decrease initial value of tab counter for next line
781 by 1.
782 \< Decrease value of tab counter by 1 and set the tab stop. Can be
783 only used at the beginning of a line.
784 \' Output at a position \tabbinsep right from the normal tab stop.
785 \` Output remaining text flush-right.
786 \pushtabs Push all tab stop positions being used.
787 \poptabs Push all tab stop positions being used. \pushtabs and \poptabs
788 must be used in pairs. Nesting allowed.
789 \aX In a tabbing environment, accents are produced by \a=, \a', \a`
790 \kill Without outputting text, parse tabbing definition.
792 array
793 \begin{array}{PREAMBLE} C1 & C2 & .. & Cn \\ D1 ... \end{array}
794 Make a mathematical array. Useful to make matrix.
795 See the help of `tabular' for detailed description.
797 tabular
798 \begin{tabular}[OPT]{PREAMBLE} C1 & C2 & .. & Cn \\ D1 ... \end{tabular}
799 Make tabular.
800 [[OPT]]
801 [t] Align the top of tabular to the line.
802 [b] Align the bottom of tabular to the line.
803 [[PREAMBLE]]
804 l,r,c : indicate where entry is to be placed.
805 | : for vertical rule
806 @{EXP} : inserts the text EXP in every column. \arraycolsep or \tabcolsep
807 spacing is suppressed.
808 *{N}{PRE} : equivalent to writing N copies of PRE in the preamble. PRE
809 may contain *{N'}{EXP'} expressions.
810 p{LEN} : makes entry in parbox of width LEN. This is useful when
811 each column contains long sentences.
813 [[Usable commands in array, tabular environment]]
814 \multicolumn
815 <refer multicolumn>
816 \vline
817 <refer vline>
818 \hline
819 <refer hline>
820 \cline{i-j}
821 <refer cline>
822 \extracolsep{W}
823 <refer extracolsep>
826 See below as an example.
828 \LaTeX Expression Printed image
829 \begin{array}{ccr}
830 x+y+z & a_1 & 1 \\ x+y+z a1 1
831 x+z & a_2 & 21 \\ x+z a2 21
832 y & a_3 & 321 y a3 321
833 \end{array}
835 \[ \left(
836 \begin{array}{cccc}
837 a_{11} & a_{12} & \dots & a_{1n} \\ / a11 a12 ... a1n \
838 a_{21} & a_{22} & \dots & a_{2n} \\ | a21 a22 ... a2n |
839 \vdots & \vdots & \ddots& \vdots \\ | : : \. : |
840 a_{n1} & a_{n2} & \dots & a_{nn} \ an1 an2 ..: ann /
841 \end{array}
842 \right)\]
844 \begin{tabular}{lp{0.7\textwidth}
845 \hline ----------------------------
846 \verb|.| & Period matches with . Period matches with any
847 any single character.\\ single character.
848 \verb|*| & Asterisk matches with * Asterisk matches with 0
849 0 or more repetition or more repetition of
850 of preceding regexp. preceding regexp.
851 \\ \hline ----------------------------
852 \end{tabular}
854 (End of example)
856 \right(, \left) or \right{, left} or \right[, \left] or \right|, \left|
857 can enclose whole of array environment by parentheses, braces, brackets,
858 norm respectively. The number of `\right's and `\left's should be the
859 same, but the type of parentheses don't have to match like
860 \right( \left]. `\right.' produces the invisible parenthesis.
862 \[ Ans. \cdots \left\{ /
863 \begin{array}{ccc} | x = 5
864 x & = & 5 \\ Ans. ...<
865 y & = & 3 | y = 3
866 \end{array} \right. \] \
868 Here are the style parameters for the tabular environment.
869 \arraycolsep : half the width separating columns in an array environment
870 \tabcolsep : half the width separating columns in a tabular environment
871 \arrayrulewidth : width of rules
872 \doublerulesep : space between adjacent rules in array or tabular
873 \arraystretch : line spacing in array and tabular environments is done by
874 placing a strut in every row of height and depth
875 \arraystretch times the height and depth of the strut
876 produced by an ordinary \strut command.
878 Tabular environment cannot spread across pages. `supertabular.sty'
879 allows this.
881 tabular*
882 \begin{tabular*}{WIDTH}{PREAMBLE} ... \end{tabular*}
883 Make tabular environment with specifying its width.
884 To fill this width, use \extracolsep{} of preamble as below:
885 \begin{tabular*}{10em}[b]{|c@{\extracolsep{\fill}}|c|c|}
886 \hline
887 a & b & c \\ \hline
888 1 & 2 & 3
889 \end{tabular*}
890 See also tabular.
892 multicolumn
893 \multicolumn{N}{FORMAT}{ITEM}
894 In tabular environment,
895 replaces the next N column items by
896 ITEM, formatted according to FORMAT. FORMAT should contain at most
897 one l,r or c. If it contains none, then ITEM is ignored.
899 vline
900 \vline
901 In tabular environment,
902 draws a vertical line the height of the current row. May
903 appear in an array element entry.
906 hline
907 \hline
908 In tabular environment draws a horizontal line between rows. Must
909 appear either before the first entry (to appear above the first row) or
910 right after a \\ command. If followed by another \hline, then adds a
911 \vskip of \doublerulesep.
913 cline
914 \cline{i-j}
915 In tabular environment,
916 draws horizontal lines between rows covering columns
917 i through j, inclusive. Multiple commands may follow
918 one another to provide lines covering several disjoint
919 columns
921 extracolsep
922 \extracolsep{W}
923 for use inside an @ in the preamble. Causes a WIDTH
924 space to be added between columns for the rest of the
925 columns. This is in addition to the ordinary intercolumn
926 space.
928 picture
929 \begin{picture}(WIDTH,HEIGHT)(X,Y) ..contents.. \end{picture}
930 The picture environment allows you to create just about any kind of
931 picture you want containing text, lines, arrows and circles. You tell
932 LaTeX where to put things in the picture by specifying their
933 coordinates. A coordinate is a number that may have a decimal point
934 and a minus sign - a number like 5, 2.3 or -3.1416. A coordinate
935 specifies a length in multiples of the unit length \unitlength, so if
936 \unitlength has been set to 1cm, then the coordinate 2.54 specifies a
937 length of 2.54 centimeters. You can change the value of \unitlength
938 anywhere you want, using the \setlength command, but strange things
939 will happen if you try changing it inside the picture environment.
941 A position is a pair of coordinates, such as (2.4,-5), specifying the
942 point with x-coordinate 2.4 and y-coordinate -5. Coordinates are
943 specified in the usual way with respect to an origin, which is
944 normally at the lower-left corner of the picture. Note that when a
945 position appears as an argument, it is not enclosed in braces; the
946 parentheses serve to delimit the argument.
948 The picture environment has one mandatory argument, which is a
949 position. It specifies the size of the picture. The environment
950 produces a rectangular box with width and height determined by this
951 argument's x- and y-coordinates.
953 The picture environment also has an optional position argument,
954 following the size argument, that can change the origin. (Unlike
955 ordinary optional arguments, this argument is not contained in square
956 brackets.) The optional argument gives the coordinates of the point at
957 the lower-left corner of the picture (thereby determining the origin).
958 For example, if \unitlength has been set to 1mm, the command
960 \begin{picture}(100,200)(10,20)
962 produces a picture of width 100 millimeters and height 200
963 millimeters, whose lower-left corner is the point (10,20) and whose
964 upper-right corner is therefore the point (110,220). When you first
965 draw a picture, you will omit the optional argument, leaving the
966 origin at the lower-left corner. If you then want to modify your
967 picture by shifting everything, you just add the appropriate optional
968 argument.
970 The environment's mandatory argument determines the nominal size of
971 the picture. This need bear no relation to how large the picture
972 really is; LaTeX will happily allow you to put things outside the
973 picture, or even off the page. The picture's nominal size is used by
974 TeX in determining how much room to leave for it.
976 Everything that appears in a picture is drawn by the \put command. The
977 command
979 \put (11.3,-.3){...}
981 puts the object specified by "..." in the picture, with its reference
982 point at coordinates (11.3,-.3). The reference points for various
983 objects will be described below.
985 The \put command creates an LR box. You can put anything in the text
986 argument of the \put command that you'd put into the argument of an
987 \mbox and related commands. When you do this, the reference point
988 will be the lower left corner of the box.
990 Picture environment is obsolete I thinks, so show only commands.
992 [[COMMANDS]]
993 \put(X,Y){OBJECT}
994 \multiput(X,Y)(dX,dY){REPEAT}{OBJECT}
995 [[OBJECTS]]
996 \makebox(X,Y)[POS]{TEXT}
997 \framebox(X,Y)[POS]{TEXT}
998 \dashbox(X,Y)[POS]{TEXT}
999 (POS = l, r, b, t)
1000 \line(dX,dY){HorizontalLength}
1001 \vector(dX,dY){HorizontalLength} (arrow)
1002 (dX,dY = +-1, +-2, ..., +-6)
1003 \shortstack[POS]{FIRST\\SECOND\\THIRD...}
1004 \circle{DIAMETER}
1005 \circle*{DIAMETER} (Filled circle)
1006 (Maximum diameters are 40pt, 15pt)
1007 \oval(Dia-X,DiaY)[POS] (Oval POS = l, r, t, b)
1008 \frame{OBJECT}
1009 \thinlines, \thicklines (choose line thickness)
1010 \linethickness{THICKNESS}
1012 newtheorem
1013 \newtheorem{NAME}{TEXT}[COUNTER] \newtheorem{NAME}[OLDNAME]{TEXT}
1014 This defines the environment NAME to be just as one would expect a
1015 theorem environment to be, except that it prints ``TEXT'' instead of
1016 ``Theorem''.
1018 If OLDNAME is given, then environments NAME and OLDNAME use the same
1019 counter, so using a NAME environment advances the number of the next
1020 NAME environment, and vice-versa.
1022 If COUNTER is given, then environment NAME is numbered within COUNTER.
1023 E.g., if COUNTER = subsection, then the first NAME in subsection 7.2
1024 is numbered TEXT 7.2.1.
1026 The way NAME environments are numbered can be changed by redefining
1027 \theNAME.
1029 title
1030 \title{TITLE}
1031 Define the title of the document.
1033 author
1034 \author{AUTHOR}
1035 Declare the author of the document.
1037 date
1038 \date{DATE}
1039 Define the date of document which is used by \maketitle.
1040 Omitting DATE produces current date.
1042 thanks
1043 \thanks{FOOTNOTE}
1044 Output a footnote in title page.
1046 maketitle
1047 \maketitle
1048 Output a title. Should be written in document environment.
1049 Here are the constituents of title page.
1050 \title{TITLE}
1051 \author{AUTHOR}
1052 \date{DATE} (If DATE omitted, output the date of typesetting)
1053 \thanks{NOTE} (Output a thanks message or the post of the author)
1055 part
1056 \part{TITLE}
1057 Start a new part whose title is TITLE.
1058 <refer chapter>
1060 chapter
1061 \chapter{TITLE}
1062 Start a chapter whose title is TITLE.
1063 Sectioning commands:
1064 \part Part ?
1065 \chapter Chapter ? (not available in `article.sty')
1066 \section ?
1067 \subsection ?.?
1068 \subsubsection ?.?.?
1069 \paragraph ***
1070 \subparagraph ===
1072 section
1073 \section{TITLE}
1074 Start a section whose title is TITLE.
1075 <refer chapter>
1077 subsection
1078 \subsection{TITLE}
1079 Start a subsection whose title is TITLE.
1080 <refer chapter>
1082 subsubsection
1083 \subsubsection{TITLE}
1084 Start a paragraph whose title is TITLE.
1085 <refer chapter>
1087 paragraph
1088 \paragraph{TITLE}
1089 Start a paragraph whose title is TITLE.
1090 <refer chapter
1092 subparagraph
1093 \subparagraph{TITLE}
1094 Start a subparagraph whose title is TITLE.
1095 <refer chapter>
1097 appendix
1098 \appendix
1099 Declare the beginning of appendix.
1100 Change the numbering fashion to appendix oriented.
1102 contentsline
1103 \contentsline{TYPE}{ENTRY}{PAGE}
1104 \contentsline{subsection}{\makebox{30pt}[r]{1.4.3} Gnats and Gnus}{22}
1105 Macro to produce a TYPE entry in a table of contents, etc.
1106 It will appear in the .TOC or other file. For example,
1107 The entry for subsection 1.4.3 in the table of contents might
1108 be produced by:
1109 \contentsline{subsection}{\makebox{30pt}[r]{1.4.3} Gnats and Gnus}{22}
1110 The \protect command causes command sequences to be written
1111 without expanding them.
1113 addcontentsline
1114 \addcontentsline{TABLE}{TYPE}{ENTRY}
1115 User command for adding his own entry to a table of contents, etc.
1116 It adds the entry
1117 \contentsline{TYPE}{ENTRY}{page}
1118 to the .TABLE file.
1120 addtocontents
1121 \addtocontents{TABLE}{TEXT}
1122 Adds TEXT to the .TABLE file, with no page number.
1124 index
1125 \index{INDEX}
1126 Create an entry of index.
1129 glossary
1130 \glossary{STRING}
1131 Create an entry of glossary.
1133 makeindex
1134 \makeindex
1135 Writes \indexentry to .idx file.
1136 Should be in preamble.
1138 makeglossary
1139 \makeglossary
1140 Writes \glossaryentry to .glo file.
1141 Should be in preamble.
1143 bibliography
1144 \bibliography{FILE1,FILE2, ... ,FILEn}
1145 Specifies the bibdata files.
1147 bibliographystyle
1148 \bibliographystyle{STYLE}
1149 Style of numbering of bibliographies.
1150 plain normal
1151 unsrt without sorting
1152 alpha gives tag like "Foo94"
1153 abbrv omit the first name of author, publishing month, book title
1155 thebibliography
1156 \begin{thebibliography}{LONGEST-LABEL} \bibitem{ITEM},... \end{thebibliography}
1157 The thebibliography environment is a list environment. To save the
1158 use of an extra counter, it should use enumiv as the item counter.
1159 Instead of using \item, items in the bibliography are produced by the
1160 \bibitem command.
1161 LONGEST-LABEL is a dummy string to notify the maximum width of label.
1162 ---
1163 <refer bibitem>
1165 bibitem
1166 \bibitem{NAME} \bibitem[LABEL]{NAME}
1167 Produces a numbered (as [1], [2],...) entry cited as NAME.
1168 Second form produces an entry labeled by LABEL and cited as NAME.
1170 thefootnote
1171 In usual LaTeX style, produces the footnote number.
1172 If footnotes are to be numbered within pages, then the
1173 document style file must include an \@addtoreset command
1174 to cause the footnote counter to be reset when the page
1175 counter is stepped. This is not a good idea, though,
1176 because the counter will not always be reset in time
1177 to ensure that the first footnote on a page is footnote
1178 number one.
1180 footnote
1181 \footnote{NOTE} or \footnote[NUM]{NOTE}
1182 User command to insert a footnote.
1183 In second form, insert a footnote numbered
1184 NUM, where NUM is a number -- 1, 2,
1185 etc. For example, if footnotes are numbered
1186 *, **, etc. within pages, then \footnote[2]{...}
1187 produces footnote '**'. This command does not
1188 step the footnote counter.
1189 (fragile)
1191 footnotemark
1192 \footnotemark[NUM]
1193 Command to produce just the footnote mark in
1194 the text, but no footnote. With no argument,
1195 it steps the footnote counter before generating
1196 the mark.
1198 footnotetext
1199 \footnotetext[NUM]{TEXT}
1200 Command to produce the footnote but no mark.
1201 \footnote is equivalent to \footnotemark \footnotetext .
1203 footnotesize
1204 {\footnotesize ...}
1205 Size-changing command for footnotes.
1207 footnotesep
1208 \footnotesep
1209 The height of a strut placed at the beginning of every footnote.
1211 footnoterule
1212 \footnoterule
1213 Macro to draw the rule separating footnotes from text.
1214 It is executed right after a \vspace of \skip\footins.
1215 It should take zero vertical space--i.e., it should to
1216 a negative skip to compensate for any positive space
1217 it occupies. (See PLAIN.TEX.)
1219 documentstyle
1220 \documentstyle[OPTION1,OPTION2, ... ,OPTIONn]{STYLE}
1221 The user starts his file with the command as above
1222 which saves the OPTION's and \input's the file STYLE.STY.
1224 verb
1225 \verb#CONTENTS#
1226 The command \verb produces in-line verbatim text, where the argument
1227 is delimited by any pair of characters. E.g., \verb #...# takes
1228 '...' as its argument, and sets it verbatim in \tt font.
1230 The *-variants of these commands is the same, except that spaces
1231 print as the TeXbook's space character instead of as blank spaces.
1233 styleparameter
1235 topfigrule
1236 \topfigrule
1237 Command to place rule (or whatever) between floats
1238 at top of page and text. Executed in inner vertical
1239 mode right before the \textfloatsep skip separating
1240 the floats from the text. Must occupy zero vertical
1241 space. (See \footnoterule.)
1243 botfigrule
1244 \setlength{\botfigrule}{LENGTH}
1245 Same as \topfigrule, but put after the \textfloatsep
1246 skip separating text from the floats at bottom of page.
1248 intextsep
1249 \setlength{\intextsep}{LENGTH}
1250 Space left on top and bottom of an in-text float.
1252 newpage
1253 \newpage
1254 Advance to a new page.
1255 \clearpage Output the unfinished table of images, if any,
1256 and clear page.
1257 \cleardoublepage Same as \clearpage except that when spread style
1258 (such as book), start a new page with odd page.
1259 \newpage Finish current column when twocolumn.
1261 clearpage
1262 \clearpage
1263 <refer newpage>
1265 cleardoublepage
1266 \cleardoublepage
1267 <refer newpage>
1269 length
1271 Here are the available units of length in TeX.
1272 cm centi meter
1273 em width of `M'
1274 ex height of `x'
1275 in inch (=2.54cm)
1276 mm mi.li meter
1277 pc pica(=12pt)
1278 pt point (72.27pt=1 inch)
1279 \fill Freely extendable length whose normal length is 0
1280 \stretch{X} X-times as long as \fill
1282 stretch
1283 \stretch{X}
1284 <refer length>
1286 twocolumn
1287 \twocolumn[STRING]
1288 Clear page and start two-column typesetting.
1289 Optional argument [STRING] specifies the page-acrossing title.
1290 ->onecolumn
1292 onecolumn
1293 \onecolumn
1294 Clear page and start one-column typesetting.
1295 ->twocolumn
1297 topnewpage
1298 \topnewpage{BOX}
1299 Begin a new page and create the parbox-ed BOX whose width is \textwidth.
1300 This is useful to make a page-acrossing title in a twocolumn page.
1302 breakbox
1303 \begin{breakbox} ... \end{breakbox}
1304 Make a surrounding frame extended across pages.
1305 Useful for cite a long program list.
1306 Requires `\usepackage{eclbkbox}'
1308 verbfile
1309 \verbfile{FILE}
1310 Include a FILE in verbatim format.
1311 Requires `\usepackage{misc}'
1312 See also \listing
1314 listing
1315 \listing{FILE}
1316 Include a FILE in verbatim format with line number.
1317 Requires `\usepackage{misc}'
1318 See also \verbfile
1320 ascmac
1321 \usepackage{ascmac}
1322 The `ascmac' package provides
1323 * \boxnote environment notebook-like box
1324 * \screen environment corner-rounded box suitable for screen output
1325 * \itembox environment itemizing box
1326 * \shadebox environment shaded box
1327 * \keytop macro keytop
1328 * \yen Yen mark
1329 * \return-key
1330 * \mask, \maskbox
1332 boxnote
1333 \begin{boxnote} ... \end{boxnote}
1334 Enclose with notebook-like square.
1335 Defined in ascmac.sty.
1337 <refer ascmac>
1339 screen
1340 \begin{screen} ... \end{screen}
1341 Enclose with corner-rounded square which stands for screen output.
1342 Requires `\usepackage{ascmac}'
1344 <refere ascmac>
1346 itembox
1347 \begin{itembox}{ITEMSTRING} ... \end{itembox}
1348 Enclose box with ITEMSTRING header.
1349 Requires `\usepackage{ascmac}'
1350 <refere ascmac>
1352 shadebox
1353 \begin{shadebox} ... \end{shadebox}
1354 Enclose shaded box.
1355 Requires `\usepackage{ascmac}'
1356 <refere ascmac>
1358 keytop
1359 \keytop{KEY}
1360 Output a keytop designed character.
1361 Requires `\usepackage{ascmac}'
1362 <refere ascmac>
1364 mask
1365 \mask{STRING}{MASKTYPE}
1366 Make a masked STRING. MASKTYPE is one of character A through K.
1368 eg.) \mask{This is a pen!}{C}
1370 Mask types are viewed at
1371 http://www.yatex.org/help/ascmac-mask.jpg
1373 Defined in `\usepackage{ascmac}'
1375 <refere ascmac>
1377 maskbox
1378 \maskbox{WIDTH}{HEIGHT}{MASKTYPE}{POS}{STRING}
1379 Make a masked box of WIDTH x HEIGHT which contains STRING located in POS.
1380 Masking type MASKTYPE is one of character A through K.
1382 eg.) \maskbox{5cm}{2.5em}{G}{c}{Year!}
1384 Mask types are viewed at
1385 http://www.yatex.org/help/ascmac-mask.jpg
1387 Requires `\usepackage{ascmac}'
1388 <refere ascmac>
1390 alltt
1391 \begin{alltt} ... \end{alltt}
1392 An environment like verbatim except in which TeX macro can be used.
1394 comment
1395 \begin{comment} ... \end{comment}
1396 Comment out enclosed environment.
1397 But if \includeversion{comment} appears, enclosed part activated.
1398 Putting \excludeversion{ENV} defines new environment ENV which
1399 works equivalently to comment environment.
1401 Requires `\usepackage{version}'
1403 bou
1404 \bou{STRING}
1405 Put the emphasizing dot on each characters in STRING.
1407 Requires `\usepackage{plext}'
1409 url
1410 \url{URL_STRING}
1411 Put URL string with reasonable folding.
1413 Requires `\usepackage{url}'
1415 longtable
1416 \begin{longtable}{POSSTRING} ... \end{longtable}
1417 Same as table, but can be spreaded across pages.
1419 Requires `\usepackage{longtable}'
1421 fancybox
1422 \usepackage{fancybox}
1423 Provides some fancy boxes.
1424 * \shadowbox{}
1425 * \ovalbox{}
1426 * \doublebox{}
1428 shadowbox
1429 \shadowbox{STRING}
1430 Surround a STRING by shadow box.
1432 Require `\usepackage{fancybox}`
1434 <ref fancybox>
1436 ovalbox
1437 \ovalbox{STRING}
1438 Surround a STRING by oval box
1440 Require `\usepackage{fancybox}`
1442 <ref fancybox>
1444 Ovalbox
1445 \Ovalbox{STRING}
1446 Surround a STRING by thick oval box.
1448 Require `\usepackage{fancybox}`
1450 <ref fancybox>
1452 doublebox
1453 \doublebox{STRING}
1454 Surround a STRING by double frame.
1456 Require `\usepackage{fancybox}`
1458 <ref fancybox>
1462 YaTeX
1463 (setq auto-mode-alist (cons '("\\.tex$" . yatex-mode) auto-mode-alist))
1464 The mode you are probably using now.
1465 Bells and whistles for using LaTeX at a breeze.
1467 [pronunciation]
1468 ``ya-tek'' for programs as yatex.el, ``ya-cho'' when referring to the
1469 whole system. ``ya-cho'' in Japanese stands for ``wild bird''
1472 yatex
1473 (setq auto-mode-alist (cons '("\\.tex$" . yatex-mode) auto-mode-alist))
1474 <refer YaTeX>