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

Introduce change in Command choice in documentation

Browse source
This commit is contained in:
Bela 2018-05-09 13:08:32 +02:00
parent af5f403ad0
commit 713b1d30a1
1 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/Configspecification.txt
View file

@ -180,8 +180,8 @@ FieldStateOption: ...
which appears several times with all possibilities. Usually those are On (or Ja) and Off or 1, 2, 3, ..., Off. which appears several times with all possibilities. Usually those are On (or Ja) and Off or 1, 2, 3, ..., Off.
For those it only makes sense to use one of those options. Hence a different type of input than Question is possible and necessary. For those it only makes sense to use one of those options. Hence a different type of input than Question is possible and necessary.
As with Question (see above Commands: Question) you can specify the (sub)infos Prompt and Help. The help is displayed in case of the input '?'. (An option '?' is not supported but that should hardly exist anyway.) As with Question (see above Commands: Question) you can specify the (sub)infos Prompt and Help. The help is displayed in case of the input '?'.
Additionally for every option specified by FieldStateOption, a short explanation/ name should be supplied via the subkey Option-op (for the option op ∈ {On, Off, Ja} ∪ ℕ). E.g. for the command Choice with the specifier c: Additionally for every option specified by FieldStateOption, a short explanation/ name should be supplied via the subkey Option-op (for the option op ∈ {On, Off, Ja, Nein} ∪ ℕ). E.g. for the command Choice with the specifier c:
FieldStateOption: 1 FieldStateOption: 1
FieldStateOption: 2 FieldStateOption: 2
@ -196,23 +196,37 @@ If the user inputs nothing (a.k.a. only presses Enter) a default value can be us
c-Enter: 1 c-Enter: 1
(The value of the info -Enter can include variables.)
If no Enter is specified, the help is displayed in case of an empty input. If no Enter is specified, the help is displayed in case of an empty input.
In order to input nothing the user presses Ctrl+D, explanation see above at Commands: Question. In order to input nothing the user presses Ctrl+D, explanation see above at Commands: Question.
After the prompt the user sees all options with a numbering. The default is at the beginning, followed by Yes-type options, followed by numbered options, followed by No-type options and followed by the remaining ones sorted alphabetically.
The user input is understood in the following way: The user input is understood in the following way:
If it is one of the options, use this option. Ctrl+D: save nothing.
Empty: save default
Natural number: option with this number in the above mentioned numbering.
Otherwise, use the first option which name/ explanation begins with the user input (case-insensitive). Otherwise, use the first option which name/ explanation begins with the user input (case-insensitive).
If none is found, ask again. If none is found, ask again.
E.g. for the example above, the following input gives the following value: E.g. for the example above, the options are
1) 1 = Beamter:in
2) 2 = Angestellte:r
3) 3 = andere:r
4) 4 (No help avaiable)
5) Off = kein:r davon
the following input gives the following value:
1 -> 1 1 -> 1
2 -> 2 2 -> 2
? -> show Help, ask again
O -> ask again O -> ask again
B -> 1 B -> 1
ang -> 2 ang -> 2
and -> 3 and -> 3
an -> ask again (since 2, 3 are possible)
k -> Off k -> Off
-> 1 (no input, just Enter pressed) -> 1 (no input, just Enter pressed)
4 -> ask again 4 -> 4
6 -> ask again
Commands: Default Commands: Default
----------------- -----------------