home *** CD-ROM | disk | FTP | other *** search
/ Computer Club Elmshorn Atari PD / CCE_PD.iso / pc / 0500 / CCE_0544.ZIP / CCE_0544 / SUPERTAB / SUPERTAB.DOC next >
Text File  |  1992-05-31  |  22KB  |  470 lines
  1. % @stylefile{Super tabular
  2. % shortpackagename = {supertab},
  3. % longpackagename  = {supertabular},
  4. % baseformats      = {\LaTeX 2.09},
  5. % version          = {3.6f},
  6. % date             = {1992-03-11},
  7. % author           = {Theo Jurriens, 
  8. %                     TAJ@HGRRUG5, 
  9. %                     P.O Box 800, 
  10. %                     9700 AV Groningen},
  11. % abstract         = {This file provides the supertabular environment, which
  12. %                     is an extension to the standard tabular environment.
  13. %                     Large tabulars are automatically split across pages.
  14. %                     Seperate commands for the table-head and table-tail
  15. %                     are provided, in order to repeat these on each page.}
  16. % infauthor        = {Johannes Braams,
  17. %                     J.L.Braams@research.ptt.nl,
  18. %                     PTT Research,
  19. %                     P.O. Box 421,
  20. %                     2260 AK Leidschendam}
  21. % infdate           = {1990-10-16}}
  22. %
  23. %----------------------------------------------------------------------------
  24. %
  25. % supertabular sty
  26. % original idea:  Theo Jurriens 1988
  27. %                 TAJ@hgrrug5        P.O Box 800, 9700 AV Groningen
  28. %
  29. % revised by:     Johannes Braams
  30. %                 JL_Braams@pttrnl.nl   PTT Research Leidschendam (NL)
  31. %
  32. % 11.02.92  - Bug found by Michael Heissmeier when p{...} is used.
  33. % V 3.6f      A change in LaTeX.tex didn't find its way into supertabular.
  34. % 01.08.91  - Take height of tabletail into account when computing the
  35. % V 3.6e      maximum tableheight; add tolerance on first (partial) page
  36. %             of the supertabular.
  37. % 27.06.91  - Cured bug that made the first part of the table one line
  38. % V 3.6d      shorter than the others. Appeared when supertabular was
  39. %             used in a twocolumn environment.
  40. % 26.06.91  - Made \@process@tablecaption a global macro. Previous caption
  41. % V 3.6c      turned up on a table without one.
  42. % 27.05.91  - Replaced \clearpage with \newpage to make supertabulars work
  43. % V 3.6b      in a twocolumn environment. This also prevents all floats
  44. %             from being printed.
  45. % 15.02.91  - Because of the check for the use of tablefirsthead the
  46. % V 3.6a      combination of an \hline in the head and an \hline as the first
  47. %             thing in the data went wrong. The \futurelet in the definition
  48. %             of \hline found \fi instead of \hline, so no \doublerulesep
  49. %             was added.
  50. %             Also had to modify the way the environments were defined.
  51. %             The blank space (from the CR after the argument of \supertabular)
  52. %             has to be gobbled. This can only be done using a construction
  53. %             like \def\command#1 {...}. So removed the use of \newenvironment
  54. % 04.02.91  - Added the commands \topcaption, \bottomcaption and \tablecaption 
  55. % V 3.6       to include a caption within the supertabular environment. The
  56. %             default behaviour is to put the caption before the actual start
  57. %             of the table.
  58. %           - Also added \tablefirsthead and \tablelasttail to let the
  59. %             user specify a different head for the first page of the table
  60. %             and for consecutive pages as well as different tails for first
  61. %             pages and the last one. If these commands are not used, the
  62. %             default behaviour will be to use the value of \tablehead end
  63. %             \tabletail
  64. %           - Removed the need for the \noalign{\global\let\\=\@stabularcr}
  65. %             commands by storing and resetting \@stabularcr
  66. %
  67. % 16.10.90  Added the supertabular* environment that was in an earlier
  68. % V 3.5     version (2.0) by the original author
  69. %           Reintroduced the version numbering
  70. %
  71. % revised by:     Gabriele Kruljac
  72. %                 kruljac@ds0mpi11   Max-Planck-Institute Stuttgart
  73. %
  74. %
  75. % 06.06.89  Correction: now care is taken of probably existing onecolumn
  76. %           head (title or tables ...) in twocolumn sty.
  77. %
  78. % 10.05.89  Correction: the new \\ definition has been added to the
  79. %           begin of each `sub'-tabular
  80. %           Added: algorithm to produce the tabulars in twocolumn style
  81. %
  82. % 06.04.89  Correction: put \global statement in \end{supertabular}
  83. %           into \noalign
  84. %
  85. % 22.02.89  Correction: restore the original meaning of \\ with
  86. %           \end{supertabular}
  87. %
  88. % (Feb 89) The whole algorithm has been changed, so that I can use
  89. %          the most features of a normal tabular:
  90. %          \\  for new line, including  \\[#1]
  91. %          p{...} in the preamble ...
  92. %          Account is taken to \baselinestretch and \arraystretch
  93. %         -I'm not counting the lines because of too much rounding errors
  94. %          but instead I add the (estimated) used space in pt.
  95. %         -The tablehead is taken into this algorithm of proofing, so
  96. %          I really know how much space the head uses.
  97. %         -When no p-arg is given I add a variable \midlineheight to
  98. %          calculate the used space. To calculate \midlineheight I
  99. %          take the \baselineskip, which is active when the supertabular
  100. %          starts (\baselineskip includes the \value of \baselinestretch)
  101. %          and multiply it with \arraystretch.
  102. %         -When a p-arg is given the text will be stored in a box. So
  103. %          I know the height I have to add. Also I reduce the maximum
  104. %          pagesize, so that the last parbox on a page can get up to
  105. %          max 4 lines without producing an overfull vbox.
  106. %         -To do so I had to make some additions to LaTeX's tabular
  107. %          commands. These new commands got a leading `s'.
  108. %
  109. %          Weak points:
  110. %          -When the material of a normal entry (not a p-arg) becomes
  111. %           larger than the estimated \midlineheight, overfull vboxes
  112. %           will be produced at all.
  113. %          -When the last p-arg on a page gets more than 4 lines
  114. %           (probably even more than 3 lines) it will result in an
  115. %           overfull vbox.
  116. %           Also some combinations of \baselinestretch \arraystretch and
  117. %           a large font may lead to one line too much.
  118. %          -if accidentally the last line of the tabular produces
  119. %           a newpage, on the next page the tabletail will be written
  120. %           immediately after the tablehead. Depending on the contents
  121. %           this may result in an error message regarding misplaced
  122. %           \noalign.
  123. %
  124. %           A quick but not very elegant solution: shrink \maxsize by
  125. %           \noalign{\global\maxsize=...pt} after the first \\ of the
  126. %           supertabular.
  127. %
  128. %------------------------------------------------------------------------------ 
  129. % Added the user-commands \topcaption and \bottomcaption which set the boolean
  130. % @topcaption to determine where to put the tablecaption. The default
  131. % is to put the caption on the top of the table
  132. %
  133. \newif\if@topcaption \@topcaptiontrue
  134. \def\topcaption{\@topcaptiontrue\tablecaption}
  135. \def\bottomcaption{\@topcaptionfalse\tablecaption}
  136. %
  137. % Added the command \tablecaption, with the use of the definition
  138. % of the \caption and \@caption commands from latex.tex.
  139. % This command has to function exactly like \caption does except it
  140. % has to store its argument (and the optional argument) for later
  141. % processing WITHIN the supertabular environment
  142. % JB
  143. %
  144. \long\def\tablecaption{\refstepcounter{table} \@dblarg{\@xtablecaption}}
  145. \long\def\@xtablecaption[#1]#2{%
  146.   \long\gdef\@process@tablecaption{\@stcaption{table}[#1]{#2}}}
  147. \global\let\@process@tablecaption\relax
  148. %
  149. %
  150. % This is a redefinition of LaTeX's \@caption, \@makecaption is
  151. % called within a group so as not to return to \normalsize globally.
  152. % also a fix is made for the `feature' of the \@makecaption of article.sty and
  153. % friends that a caption ALWAYS gets a \vskip 10pt at the top and NONE at the
  154. % bottom. If a user wants to precede his table with a caption this results
  155. % in a collision.
  156. %
  157. \long\def\@stcaption#1[#2]#3{\par%
  158.     \addcontentsline{\csname ext@#1\endcsname}{#1}%
  159.         {\protect\numberline{\csname the#1\endcsname}{\ignorespaces #2}}
  160.   \begingroup
  161.     \@parboxrestore
  162.     \normalsize
  163.     \if@topcaption \vskip -10pt \fi % 'fix' 
  164.     \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par
  165.     \if@topcaption \vskip 10pt \fi % 'fix' 
  166.   \endgroup}
  167. %
  168. %                             % \tablehead activates the new tabular \cr
  169. %                             % commands
  170. \def\@tablehead{}
  171. \def\tablehead#1{\gdef\@tablehead{#1}}
  172. \def\tablefirsthead#1{\gdef\@table@first@head{#1}}
  173. % 
  174. %+
  175. %     If the user uses an extra amount of tabular-data (like \multicolumn)
  176. %     in \verb=\tabletail= \TeX\ starts looping because of the definition
  177. %     of \verb=\nextline=. So make \verb=\\= act like just a \verb=\cr=
  178. %     inside this tail to prevent the loop. 
  179. %     Save and restore the value of \verb=\\=
  180. %-
  181. \def\@tabletail{}
  182. \def\tabletail#1{%
  183.     \gdef\@tabletail{\noalign{\global\let\@savcr=\\\global\let\\=\cr}%
  184.                      #1\noalign{\global\let\\=\@savcr}}}
  185. \def\tablelasttail#1{\gdef\@table@last@tail{#1}}
  186. % 
  187. \newdimen\maxsize            % maximum pagesize
  188. \newdimen\actsize            % actual pagesize
  189. \newdimen\twocolsize         % needed for correct max height if twocolumn
  190. \newdimen\parboxheight       % height plus depth of a parbox-argument
  191. \newdimen\addspace           % stores the value of \\[#1]
  192. \newdimen\midlineheight      % estimated size of a normal line
  193. \newdimen\pargcorrection     % to set page height tolerance if p-arg
  194. \newdimen\computedimens      % computation variable
  195. \newbox\tabparbox
  196. % 
  197. %         %%%%  Redefine original LaTeX tabular \cr commands. %%%%
  198. %         %%%%  New tabular \cr commands get a leading `s'    %%%%
  199. % 
  200. %                             % Insert  \nextline command for counting
  201. \def\@stabularcr{{\ifnum0=`}\fi\@ifstar{\@sxtabularcr}{\@sxtabularcr}}
  202. \def\@sxtabularcr{\@ifnextchar[{\@sargtabularcr}%
  203.                  {\ifnum0=`{\fi}\cr\nextline}}
  204. % 
  205. %                             % contents of command unchanged
  206. \def\@sargtabularcr[#1]{\ifnum0=`{\fi}\ifdim #1>\z@
  207.     \unskip\@sxargarraycr{#1}\else \@syargarraycr{#1}\fi}
  208. % 
  209. %                             % here copy the value #1 of [ ] of \\
  210. %                             % to \addspace
  211. \def\@sxargarraycr#1{\@tempdima #1\advance\@tempdima \dp \@arstrutbox%
  212.     \vrule \@height\z@ \@depth\@tempdima \@width\z@ \cr%
  213.     \noalign{\global\addspace=#1}\nextline}
  214. % 
  215. %                             % command will be called when \\[0pt]
  216. \def\@syargarraycr#1{\cr\noalign{\vskip #1\global\addspace=#1}\nextline}
  217. % 
  218. %         %%%%  Redefine original LaTeX p-arg commands.       %%%%
  219. %         %%%%  New commands get a leading `s'                %%%%
  220. % 
  221. %                                      % reduce maximum pagesize to have
  222. %                                      % a small tolerance for last entry
  223. \def\@sstartpbox#1{\global\advance\maxsize by -\pargcorrection
  224.                    \global\pargcorrection=0pt
  225. %                                      % put text into box to save height
  226.                    \setbox\tabparbox%
  227.                           \vtop\bgroup\hsize#1\@arrayparboxrestore}
  228. % 
  229. % 11/03/92 JB: The following change didn't find its way into the 
  230. %              \@sendpbox command. This caused a difference in linespacing
  231. %              between a supertabular and a normal tabular. 
  232. % \def\@endpbox{\unskip\strut\par\egroup\hfil}
  233. % % 14 Jan 89: Def of \@endpbox changed from
  234. % %    \def\@endpbox{\par\vskip\dp\@arstrutbox\egroup\hfil}
  235. % % so vertical spacing works out right if the last line of a `p' entry
  236. % % has a descender.
  237. \def\@sendpbox{\unskip\strut\par\egroup%
  238.                \computedimens=\ht\tabparbox%
  239.                \advance\computedimens by \dp\tabparbox%
  240.                \ifnum\parboxheight<\computedimens
  241.                   \global\parboxheight=\computedimens
  242.                \fi
  243.                \computedimens=0pt
  244.                \box\tabparbox\hfil}
  245. % 
  246. %         %%%%  Here start really new supertabular commands   %%%%
  247. % 
  248. %                                 % estimate height of normal line
  249. %                                 % regarding \array- and \baselinestretch
  250. \def\calmidlineheight{\midlineheight=\arraystretch \baslineskp
  251.                       \global\advance\midlineheight by 1pt
  252.                       \global\pargcorrection=4\midlineheight}
  253. % 
  254. \def\calpage{\global\actsize=\pagetotal  % where am I on the actual page?
  255.              \twocolsize=\textheight            %  added 06.06.89
  256.              \advance\twocolsize by -\@colroom  %        "
  257.              \advance\actsize by \twocolsize    %        "
  258.              \global\advance\actsize by \midlineheight
  259.              \maxsize=\textheight        % start a new page when 90% of
  260.              \multiply \maxsize by 9     % the page are used
  261.              \divide\maxsize by 10
  262. % Add a litle tolerance on the firsat (partial) page V3.6e
  263.              \advance\actsize 2\midlineheight
  264.              \ifnum\actsize > \maxsize
  265.                    \clearpage
  266.                    \global\actsize=\pagetotal
  267.              \fi
  268.              \maxsize=\textheight       % now set \maxsize with tolerance
  269. %+
  270. %     measure the height of the tabletail and substract from \maxsize
  271. %-
  272.              \setbox\@tempboxa=\vbox{\@arrayparboxrestore%
  273.                 \begin{tabular}{\tableformat}\@tabletail\end{tabular}}
  274.              \global\advance\maxsize by-\ht\@tempboxa}
  275.                              % Here is the definition of supertabular
  276. % modified JB (15.2.91)
  277. \def\supertabular#1 {%           % before it was \edef\tableformat,
  278. %                                % but gave error with @{\hspace{..}} !
  279.     \def\tableformat{\string#1} % store preamble
  280.     \global\starfalse % remember this is the normal version
  281. % 
  282. %                                 % Check if we have to insert a caption
  283.     \if@topcaption\@process@tablecaption
  284.     \fi
  285. %                                 % save old \\ moved from below V3.6e
  286.     \global\let\@oldcr=\\
  287. % 
  288.     \def\baslineskp{\baselineskip}
  289.     \calmidlineheight% estimate height of a normal line
  290.     \calpage         % calculate max. pagesize and startpoint
  291. % 
  292. %                                 % save old \@tabularcr
  293.     \let\@@tabularcr\@tabularcr%             Added JB 4/2/91
  294. %                                % Now insert the definition of \@stabularcr
  295.     \let\@tabularcr\@stabularcr
  296. %                                 % activate new parbox algorithm
  297.     \let\@@startpbox=\@sstartpbox
  298.     \let\@@endpbox=\@sendpbox
  299. %
  300. %    Moved the check for the use of \tablefirsthead to befor the start of
  301. %    the tabular environment in order to make the \futurelet inside \hline
  302. %    do its work correctly (15.02.91)
  303. %
  304.     \ifx\@table@first@head\undefined
  305.         \let\@@tablehead=\@tablehead
  306.     \else
  307.         \let\@@tablehead=\@table@first@head
  308.     \fi%                                     Added JB 4/2/91
  309. %                                 % start normal tabular environment
  310.     \begin{tabular}{\tableformat}%
  311.     \@@tablehead}%   Added JB 15/2/91
  312. %
  313. %                                 % this is \end{supertabular}
  314. \def\endsupertabular{%
  315.     \ifx\@table@last@tail\undefined%
  316.         \@tabletail%
  317.     \else%
  318.         \@table@last@tail%
  319.     \fi%                                     Added JB 4/2/91
  320. %removed JB                \noalign{\global\let\\=\@oldcr}%
  321. %   \let\@@startpbox=\@startpbox%
  322. %   \let\@@endpbox=\@endpbox%
  323.     \end{tabular}
  324. %                                 % restore old \@tabularcr
  325.     \let\@tabularcr\@@tabularcr             % Added JB 4/2/91
  326. %                                 % Check if we have to insert a caption
  327.     \if@topcaption
  328.     \else
  329.         \@process@tablecaption
  330. %                                 % restore to default behaviour
  331.         \@topcaptiontrue
  332.     \fi
  333. %+
  334. %    Restore the meaning of \verb=\\= to the one it had before the start
  335. %    of this environment. Also re-initialize some control-sequences
  336. %-
  337.     \global\let\\=\@oldcr
  338.     \let\@table@first@head\undefined        % For the next ocurrence
  339.     \let\@table@last@tail\undefined         % of this environment   
  340.     \global\let\@process@tablecaption\relax
  341. }
  342. % 
  343. %                             % Here is the definition of supertabular*
  344. \newif\ifstar
  345. \newdimen\tabularwidth
  346. \@namedef{supertabular*}#1#2 {% modified JB (15.2.91)
  347. %                                 % before it was \edef\tableformat,
  348. %                                 % but gave error with @{\hspace{..}} !
  349.     \def\tableformat{\string#2} % store preamble
  350.     \tabularwidth=#1 % The total width of the tabular
  351.     \global\startrue % remember this is the *-version
  352. % 
  353. %                                 % Check if we have to insert a caption
  354.     \if@topcaption\@process@tablecaption\fi
  355. %
  356.     \def\baslineskp{\baselineskip}
  357.     \calmidlineheight% estimate height of a normal line
  358.     \calpage         % calculate max. pagesize and startpoint
  359. % 
  360. % 
  361. %                                 % save old \@tabularcr
  362.     \let\@@tabularcr\@tabularcr%              Added JB 4/2/91
  363. %                                % Now insert the definition of \@stabularcr
  364.     \let\@tabularcr\@stabularcr%              Added JB 4/2/91
  365. %                                 % save old \\
  366.     \global\let\@oldcr=\\
  367. % 
  368. %                                 % activate new parbox algorithm
  369.     \let\@@startpbox=\@sstartpbox
  370.     \let\@@endpbox=\@sendpbox
  371. %
  372. %    The same modification as for \tabular 15.2.91
  373.     \ifx\@table@first@head\undefined
  374.         \let\@@tablehead\@tablehead
  375.     \else
  376.         \let\@@tablehead\@table@first@head
  377.     \fi%                                     Added JB 4/2/91
  378. %                                 % start normal tabular environment
  379.     \begin{tabular*}{\tabularwidth}{\tableformat}%
  380. %
  381. %removed JB                \noalign{\global\let\\=\@stabularcr}
  382.     \@@tablehead}%
  383. %                                 % this is \end{supertabular*}
  384. \@namedef{endsupertabular*}{%
  385.     \ifx\@table@last@tail\undefined%
  386.         \@tabletail%
  387.     \else%
  388.         \@table@last@tail%
  389.     \fi%                                     Added JB 4/2/91
  390. %removed JB                \noalign{\global\let\\=\@oldcr}%
  391.     \end{tabular*}
  392. %                                 % restore old \@tabularcr
  393.     \let\@tabularcr\@@tabularcr
  394. %               \let\@@startpbox=\@startpbox%
  395. %               \let\@@endpbox=\@endpbox%
  396.                                  % Check if we have to insert a caption
  397.     \if@topcaption
  398.     \else
  399.         \@process@tablecaption
  400.                                  % restore to default behaviour
  401.         \@topcaptiontrue
  402.     \fi
  403. %+
  404. %    Restore the meaning of \verb=\\= to the one it had before the start
  405. %    of this environment. Also re-initialize some control-sequences
  406. %-
  407.     \global\let\\=\@oldcr
  408.     \let\@table@first@head\undefined        % For the next ocurrence
  409.     \let\@table@last@tail\undefined         % of this environment   
  410.     \global\let\@process@tablecaption\relax}
  411. % 
  412. \def\nextline{%           %%% algorithm to calculate the pagebreaks %%%
  413.     \noalign{\ifnum\parboxheight<\midlineheight
  414. % V3.6e, non-empty line, but empty parbox, then \parboxheight might
  415. % be non-zero, but too small thereby breaking the algorithm.
  416. %                                 % if no p-arg add `normal' line height
  417.                    \advance\actsize by \midlineheight
  418. %                                      % \addspace is value #1 of \\[#1]
  419.                    \global\advance\actsize by \addspace
  420.              \else
  421. %                                 % if p-arg add height of box and more
  422.                    \global\advance\actsize by \parboxheight
  423.                    \divide\parboxheight by 11\relax
  424.                    \global\advance\actsize by \parboxheight%
  425.                    \global\parboxheight=0pt
  426.              \fi
  427.              \global\addspace=0pt}%
  428. %                                      % when page becomes full:
  429.     \ifnum\actsize<\maxsize
  430. %
  431. %    This line is necessary because the tablehead has to be inserted *after*
  432. %    the \if\else\fi-clause. For this purpose \next is used. In the middle
  433. %    of tableprocessing it shoud be an *empty* macro (*not* \relax).
  434. %    (15.2.91)
  435.     \noalign{\global\let\next\@empty}
  436.     \else
  437. %                                      % output \tabletail, close tabular
  438. %                                      % output all material and start a
  439. %                                      % fresh new page
  440.          \@tabletail
  441.          \ifstar%                     % Added 16-10-90
  442.            \end{tabular*}%
  443.          \else%
  444.            \end{tabular}%
  445.          \fi
  446.          \if@twocolumn%                        % added 10.05.89
  447.             \if@firstcolumn%                   %
  448.                \newpage%                       %
  449.             \else%                             %
  450.                \clearpage%                     %
  451.             \fi%                               %
  452.             \twocolsize=\textheight%           % added 06.06.89
  453.             \advance\twocolsize by -\@colroom% %       "
  454.             \global\actsize=\twocolsize%       %       "
  455. % The following lined added 27/6/91 like in the definition of \calpage
  456.             \global\advance\actsize by \midlineheight
  457.          \else                                 %
  458.             \clearpage                         %
  459.             \global\actsize=\midlineheight%
  460.          \fi                                   %
  461.          \let\next\@tablehead%                 % Added 15.2.91
  462.          \ifstar%                              % Added 16-10-90
  463.            \begin{tabular*}{\tabularwidth}{\tableformat}%
  464.          \else%
  465.            \begin{tabular}{\tableformat}%
  466.          \fi%
  467. %removed JB         \noalign{\global\let\\=\@stabularcr}  % added 10.05.89
  468. %removed JB         \@tablehead%
  469.     \fi\next}%                                % Added \next 15.2.91
  470.