Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog
The general syntax for using each filter is shown first. By convention, the filter is shown using the block and endblock macros, although filters can also be used with other macros, including include and execute.
If a filter has one or more optional parameters, these are listed in a table containing the following columns:
Parameter types and rules follow the same conventions as macro argument types and rules. Refer to Understanding Macro Interfaces for details.
Providing data to a filter via a table is a common idiom in SDF as using tables makes it easy to add additional columns later on.
If a filter expects a table of data in TBL format, the fields in the table of data are listed in a table containing the following columns:
The supported table field categories are explained below.
Category | Description |
key | a unique value must be provided for each row |
mandatory | a value must be provided for each row |
optional | a value is optional |
As validating table fields can reduce performance quite a bit, the sdf program doesn't validate them by default. To enable table field validation, use the -v option like this:
sdf -v99 ...
Typically, this is only needed when a filter isn't working as you'd expect.
Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog