flukx/pdfformfill
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add doc for defaults in variables

Browse source
This commit is contained in:
Bela 2018-04-07 10:12:54 +02:00
parent 97bde71789
commit eb640faf0d
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/Configspecification.txt
View file

@ -225,19 +225,22 @@ If the variable interpretation did not work due to missing values, a warning is
Variable interpretation
-----------------------
To allow referencing to other fields Default and the conditions If(un)equal allow variables in the values. Variables can have one of two forms:
To allow referencing to other fields Default and the conditions If(un)equal allow variables in the values. Variables can have one of four forms:
1) for fields in the same form:
{fieldname}
{fieldname} or {fieldname#default}
where fieldname is the info saved in FieldName.
FieldName is used since it should exist for every field and should be unique in a well-formed pdf.
{fieldname} is replaced by what is saved in the info Value.
2) {form|fieldname}
where form is a specifier for an other form which form-file got read as well and fieldname is a FieldName in this other form.
If the field has no value saved, use default if given. If no # exists (aka no default is given) and no value is saved, an error is raised.
2) {form|fieldname} or {form|fieldname#default)
where form is a specifier for an other form which form-file got read as well and fieldname is a FieldName in this other form. The same as above for default applies.
When calling fillform on the commandline one can specify with the option
--data spec otherForm.form
a form-file that was produced while filling out another form (otherForm.form) and the specifier (spec) is the specifier used in variables (example above: form).
The other way to define the specifier is the field mainconfig (see there).
Variables are repeatedly replaced until there is no {, } pair is found.
{, |, }, # as special symbols are defined in constants.VARIABLE...
If
(For the reserved symbols {,},| see constants.VARIABLE_BEGIN/END/PARTS_SEP.)