pestctrl/newfol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

manual: document field definition directives.

Browse source 
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
This commit is contained in:
brian m. carlson 2014-12-07 16:25:49 +00:00
parent 43ff0d4eee
commit 8c6c5bf3c8
No known key found for this signature in database
GPG key ID: BF535D811F52F68B
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/manual.adoc
View file

@ -71,6 +71,20 @@ A table definition directive consists of a record containing the values `def`
and the table name. A table must be defined before any field definitions can
occur for that table.
==== Field Definition Directives (`fld` and `dsc`)
Field definitions come in two types. The first, `fld`, provides a mapping for
imported data, and `dsc` does not. They are otherwise identical.
A field definition directive consists of a record containing the values `fld` or
`dsc`, the name of the table, the field number for imported data (or empty for
`dsc`), the field number for use in newfol, an optional Python 3 expression, and
a description.
The Python 3 expression is evaluated and placed in the field when creating a new
record. This can be used, for example, to automatically insert the date into a
particular field.
=== Configuration File
Configuration files are identical to schema files except that instead of the