Function: texinfo-multitable

texinfo-multitable is a byte-compiled function defined in texinfmt.el.gz.

Signature

(texinfo-multitable)

Documentation

Produce multi-column tables.

A multi-column table has this template:

    @multitable {A1} {A2} {A3}
    @item A1 @tab A2 @tab A3
    @item B1 @tab B2 @tab B3
    @item C1 @tab C2 @tab C3
    @end multitable

where the width of the text in brackets specifies the width of the respective column.

Or else:

    @multitable @columnfractions .25 .3 .45
    @item A1 @tab A2 @tab A3
    @item B1 @tab B2 @tab B3
    @end multitable

where the fractions specify the width of each column as a percent of the current width of the text (i.e., of the fill-column).

Long lines of text are filled within columns.

Using the Emacs Lisp formatter, texinfmt.el, the whitespace between columns can be increased by setting texinfo-extra-inter-column-width to a value greater than 0. By default, there is at least one blank space between columns.

The Emacs Lisp formatter, texinfmt.el, ignores the following four commands that are defined in texinfo.tex for printed output.

    @multitableparskip,
    @multitableparindent,
    @multitablecolmargin,
    @multitablelinespace.

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/texinfmt.el.gz
(defun texinfo-multitable ()
  "Produce multi-column tables.

A multi-column table has this template:

    @multitable {A1} {A2} {A3}
    @item  A1  @tab  A2  @tab  A3
    @item  B1  @tab  B2  @tab  B3
    @item  C1  @tab  C2  @tab  C3
    @end multitable

where the width of the text in brackets specifies the width of the
respective column.

Or else:

    @multitable @columnfractions .25 .3 .45
    @item  A1  @tab  A2  @tab  A3
    @item  B1  @tab  B2  @tab  B3
    @end multitable

where the fractions specify the width of each column as a percent
of the current width of the text (i.e., of the `fill-column').

Long lines of text are filled within columns.

Using the Emacs Lisp formatter, texinfmt.el,
the whitespace between columns can be increased by setting
`texinfo-extra-inter-column-width' to a value greater than 0.  By default,
there is at least one blank space between columns.

The Emacs Lisp formatter, texinfmt.el, ignores the following four
commands that are defined in texinfo.tex for printed output.

    @multitableparskip,
    @multitableparindent,
    @multitablecolmargin,
    @multitablelinespace."

;; This function pushes information onto the `texinfo-stack'.
;; A stack element consists of:
;;   - type-of-command, i.e., multitable
;;   - the information about column widths, and
;;   - the position of texinfo-command-start.
;; e.g., ('multitable (1 2 3 4) 123)
;; The command line is then deleted.
  (texinfo-push-stack
   'multitable
   ;; push width information on stack
   (texinfo-multitable-widths))
  (texinfo-discard-line-with-args))