Macro Language Reference > PIs > Tables > <?tbheadr>
  
<?tbheadr>
Description
This command is used to mark the start and end of table headers and their behavior during table overflows.
Syntax
<?tbheadr code:n level:n?>
code
-1
Remove headers: specify a level of header to be removed. Using this option without specifying a level will remove all headers in the table.
It is possible to use this cancel command mid row, which will allow headers to be cancelled by the end of a section, rather than requiring the start of a new section.
0
The header terminates at the end of the current row. Note that headers in the table must make up a complete row.
1
Marks the start of the header.
 
A <?tbheadr=0> command must also be included after the header text, otherwise all the table's text content will be included in the header.
2
Marks the start of the header row but the header row(s) will only be included when the table is restarting, e.g. after an overflow has occurred, and will be skipped in every other case.
 
The header will only be skipped if PTC ALD encounters an end header command.
If you wish to define text in the header that is only included at restarts, use a show string test with a getvar to test the value of the table mode &128. For example, to show "contd.":
<?show =^(v01625:128)?^(128)contd.>
level
(optional) The level of the header
Up to 5 levels of header are permitted, and can be defined by using multiple <?tbheadr> commands and specifying a level for each. When a table starts a new column/page, all the headers will be inserted in order.
Additional Information
The header command is not an instruction for a new row but an attribute for the row; you may need to include a <?tbrstrt> command with it if this has not already been specified.
Headers can also be changed midway through the table. When used in conjunction with header levels, only the specified level will be overridden: for example it is possible to display a main header on level 1 and a different subheader on level 2 for each section of the table. Here, if a change of header when whilst inserting headers, the new header will be used.
<?tbheadr=2> will ensure that, as well as the header, any changes to show string counters made during the header are also skipped.
 
A <?tbnsshow=1> setting will ensure that the header is skipped but that counter changes run through into the main body of the table.
Related Links