SDF 2.001: SDF Reference: table Filter

Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog

# 5.31. table Filter

## Interface

The general syntax is:

      !block table[; parameters]
      ...
      !endblock

The parameters are:

Name | Type | Rule
align | string |
bgcolor | string |
bmargin | integer |
cellpadding | integer |
cellspacing | integer |
colaligns | string |
coltags | string |
colvaligns | string |
delete | string |
footings | integer |
format | string |
groups | string |
headings | integer |
keepindents | boolean |
landscape | string |
listitem | integer |
lmargin | integer |
narrow | boolean |
niceheadings | boolean |
nocalcs | boolean |
noheadings | boolean |
objects | string |
oncell | string |
parseline | string |
placement | string |
rmargin | integer |
select | string |
sort | string |
style | string |
tags | string |
title | string |
tmargin | integer |
type | string |
where | string |
wide | boolean |
wrap | integer |

See Understanding Filter Interfaces, if necessary.

## Description

The table filter specifies a table in TBL format. A brief description of each parameter is given below. A tutorial-style introduction to SDF's table features is also provided in the SDF User Guide.

Parameter | Description
align | alignment of table: one of Left, Center, Right, Inner, Outer
bgcolor | background colour for a table (HTML only)
bmargin | default bottom margin for table cells (MIF only)
cellpadding | padding size for table cells (HTML only)
cellspacing | spacing size between table cells (HTML only)
colaligns | a comma-separated list of horizontal alignments values (Left, Center, Right) for columns; alternatively, a single word containing the letters L, C and R
coltags | a comma-separated list of phrase styles to apply to columns
colvaligns | a comma-separated list of vertical alignments values (Top, Middle, Bottom, Baseline) for columns; alternatively, a single word containing the letters T, M, B and L
delete | a comma-separated list of columns to delete
footings | the number of footing rows at the end of the table
format | a comma-separated list of column width specifications; alternatively, a single number where each digit represents 10% of the space available to the table
groups | pattern of group-style rows (default is /:$/)
headings | the number of heading rows at the top of the table
landscape | display the table in landscape mode (MIF only)
listitem | the list indent level (e.g. 1) of this table
lmargin | default left margin for table cells (MIF only)
narrow | if set, the table will only be as wide as required; otherwise the table will span the available space
niceheadings | set to 0 to disable _ to space conversion in headings
nocalcs | set to 0 to disable calculation processing within a table
noheadings | suppress headings in output
objects | alias for coltags (coltags is preferred)
oncell | Perl code to execute for each cell (internal use only!)
parseline | column headings parsing line (if not the first row in the text)
placement | vertical placement of table: one of Float, Pagetop, Columntop, Lefttop, Righttop (MIF only)
rmargin | default right margin for table cells (MIF only)
select | a comma-separated list of columns to display
sort | a comma-separated list of columns to sort the data rows by
style | overall look of the table
tags | alias for coltags (coltags is preferred)
title | table caption
tmargin | default top margin for table cells (MIF only)
type | alias for style (style is preferred)
where | an expression to filter the data rows with
wide | table straddles the side head area of the page
wrap | the number of data rows to display in a physical row

## Examples

A typical table is:

    !block table; format=55; style="grid"; groups; title="Diary"
    Time_of_day     Appointment
    Morning:
    10:00           Dentist
    12:00           Lunch with friends
    Afternoon:
    15:00           Meeting on SDF
    !endblock

The result is:

Diary
Time of day | Appointment
Morning: |
10:00 | Dentist
12:00 | Lunch with friends
Afternoon: |
15:00 | Meeting on SDF