Changes

< [[VisualsPresentations]] | [[Basics|Text formatting]] | [[Interaction]] >

You can find more about interactive form elements in [http://www.pragma-ade.comnl/general/manuals/mwidget-s.pdf Widgets uncovered]. It’s written for MkII, but still mostly valid. Most of the following examples are from the manual. =Fields= Create a field “class” with {{cmd|setupfield}}, then create single instances with {{cmd|definefield}}, finally typeset it with {{cmd|field}}. That might look complicated, but you can use the same field several times, and the contents will automatically repeat themselves if you need the same content at several places, even on different pages. (Think e.g. of name, location and date in a set of forms.)  Relevant commands:* {{cmd|setupfield}}* {{cmd|definefield|[name][type][setup name][content values][default content]}}* {{cmd|field|[name]}} Field types:* line: one line of text* text: more lines of text* radio: radiobutton (only one of a group can be active)* check: checkbox* signature: electronic signature (since 2016-03-11) ===Single fields=== Since you often need fields only once, you can define your own shortcut macros: <texcode>\setupfield[MyFieldSetup][reset,horizontal][... options ...]\define[1]\MyField{\definefield[#1][line][MyFieldSetup]\field[#1]}</texcode> ==Text Entries== <texcode>\setupfield[ShortLine][horizontal][width=2cm,height=2em]\definefield [Email] [line] [ShortLine] [] [sample@contextgarden.net]\field [Email] [your email]</texcode> ==Checkboxes== <texcode>\setupfield[setup 3] [width=2cm, height=2cm, rulethickness=3pt, corner=round, framecolor=red] \definesymbol [yes] [{\externalfigure[mpcont.502]}]\definesymbol [no] []\definefield [checkme][check] [setup 3] [yes,no] [no]\field[checkme]</texcode> ==Radiobuttons== Example from the manual: <texcode>\setupfield [LogoSetup] [width=4cm, height=4cm, frame=off, background=color, backgroundcolor=lightgray] \definefield[Logos] [radio] [LogoSetup][ConTeXt,PPCHTEX,TeXUtil] [PPCHTEX] \definesubfield [ConTeXt] [] [ConTeXtLogo]\definesubfield [PPCHTEX] [] [PPCHTEXLogo]\definesubfield [TeXUtil] [] [TeXUtilLogo] \definesymbol [ConTeXtLogo] [{\externalfigure[mpcont.502]}]\definesymbol [PPCHTEXLogo] [{\externalfigure[mpcont.503]}]\definesymbol [TeXUtilLogo] [{\externalfigure[mpcont.504]}] \hbox to \hsize{\hss\field[ConTeXt]\hss\field[PPCHTEX]\hss\field[TeXUtil]\hss}</texcode> As usual, first you need to define a class of fields ({{cmd|setupfield}}). Then you define the (invisible) group of radio buttons ({{cmd|definefield}} with "radio"). At last you define the single radio buttons with {{cmd|definesubfield}}. Arguments of {{cmd|definefield}}:# field name# field type "radio"# setup class, as defined by {{cmd|setupfield}}# list of field names that should be part of the group# name of default (activated) button Arguments of {{cmd|definesubfield}}:# field name# setup class (default is inherited, but you can use a different one)# content symbol, defined by {{cmd|definesymbol}} ===Setup for questionnaire=== If you need a lot of similar radiobuttons, like in a questionnaire where you answer every question with a range choice, a meta definition makes sense. Fortunately it’s quite easy: <context source=yes>\setupinteraction[state=start]\setupfield [ChoiceSetup][width=1em,height=1em,corner=00] \definesymbol[X][X] % replace with dingbat symbol \def\Choice#1{\definefield[#1:main][radio][ChoiceSetup][#1:1,#1:2,#1:3,#1:4,#1:5,#1:0][#1:0]%\definesubfield [#1:1][][X]%\definesubfield [#1:2][][X]%\definesubfield [#1:3][][X]%\definesubfield [#1:4][][X]%\definesubfield [#1:5][][X]%\definesubfield [#1:0][][X]%\field[#1:1]\,\field[#1:2]\,\field[#1:3]\,\field[#1:4]\,\field[#1:5]\hskip1em\field[#1:0]} \def\ChoiceTitle{\hfill$-$\hskip4em$+$\hskip1.25em?\ \strut\par} \def\Question{\dosingleempty\doQuestion}% We need the "optional" parameter as reference\def\doQuestion[#1]#2{% \iffirstargument #2\dotfill\Choice{#1}\par \else #2\par \fi} \starttext \ChoiceTitle\Question[q:ctx]{How much do you love \CONTEXT?}\Question[q:lua]{How are your Lua skills?}\Question[q:xml]{How often do you dream in XML?} \stoptext</context> == Fillin fields == {{cmd|fillinfield}} is meant for clozes (texts with gaps, like in questionnaires) and defined in the {{src|m-fields.mkiv|fields}} module (i.e. you need {{cmd|usemodule|[fields]}}). <texcode>\fillinfield[name]{text that defines field length}</texcode> Disable default validation with {{cmd|setupfieldcategory|2=[fillinfield][validate=]}}, because it removes the contents from the field! There are some commands with a similar purpose in the {{src|pack-mrl.mkxl|core}} that don’t use fields: * {{cmd|fillinline}}* {{cmd|fillintext}}* {{cmd|fillinrules}}

If you need want to check or otherwise process the input of your forms, you need JavaScript to handle interaction. For simple forms without input validation, you can skip don’t need this. '''Beware:''' JavaScript in PDFs works only in Adobe Acrobat Reader/Professional (Win/Mac only) and very few other PDF editors, e.g. [https://www.qoppa.com Qoppa]’s PDF Studio (also on Linux) supports JS even in the free viewer, but used to crash on all forms created with TeX in the 2019 version, maybe this sectionis fixed now.

JavaScript in Acrobat is different than in a web context. Documentation is even more sparse than on ConTeXt ;).

=Fields= {{Explanation}} Relevant commands:* {{cmd|setupfield}}, {{cmd|setupfields}}* {{cmd|definefield|[name][type][setup name][content values][default content]}}* {{cmd|field|[name]}}* {{cmd|fillinfield}}* {{cmd|fillinline}}* {{cmd|fillintext}}* {{cmd|fillinrules}} Field types:* line: one line of text* text: more lines of text* radio: radiobutton (only one of a group can be active)* check: checkbox Beware, for fillinfields in MkIV you need {{code|\usemodule[fields]}}!They’re meant for clozes (texts with gaps, like in questionnaires). In MkIV (as of 2015-04-01) default values are always used verbatim, i.e. JS() doesn’t work. Other fields you must first define Tricks and then use. That might look complicated, but you can use the same field several times, and the contents will automatically repeat themselves if you need the same content at several places, even on different pages. ==Text Entries== <texcode>\fillinfield[name]{text that defines field length}</texcode> or <context source=yes>\setupfield[ShortLine][horizontal][width=2cm,height=2em]\definefield [Email] [line] [ShortLine] [] [sample@contextgarden.net]\field [Email] [your email]</context> ==Radiobuttons=Traps= Example from the manual:

<texcode>\setupfield [LogoSetup] [width=4cm, height=4cm, frameGeneral=off, background=color, backgroundcolor=lightgray]

\definefield[Logos] [radio] [LogoSetup][ConTeXt,PPCHTEX,TeXUtil] [PPCHTEX] \definesubfield [ConTeXt] [] [ConTeXtLogo]\definesubfield [PPCHTEX] [] [PPCHTEXLogo]\definesubfield [TeXUtil] [] [TeXUtilLogo] \definesymbol [ConTeXtLogo] [* Nothing happens without {\externalfigure[mpcont.502]}]\definesymbol [PPCHTEXLogo] [{\externalfigurecmd|setupinteraction|2=[mpcont.503state=start]}]\definesymbol [TeXUtilLogo] [{\externalfigure[mpcont.504]}] \hbox to \hsize{\hss\field[ConTeXt]\hss\field[PPCHTEX]\hss\field[TeXUtil]\hss}</texcode> As usual, first ! If you need to define an interactive version and a class of fields plain one ({{cmd|setupfield}}e.g. for print). Then , then you define the must replace your form fields with something else (invisible) group of radio buttons ({{cmd|definefield}} with "radio")e. At last you define the single radio buttons with {{cmd|definesubfield}}g. Arguments of {{cmd|definefield}}:# field name# field type "radio"# setup class, as defined by {{cmd|setupfieldframed}}# list of field names that should be part of the group# name of default (activated) button Arguments of {{cmd|definesubfield}}:# field name# setup class (default is inherited, but you can use a different one)# content symbol, defined by {{cmd|definesymbol}} ==Checkboxes== <texcode>\setupfield. Use [setup 3] [width=2cm, height=2cm, rulethickness=3pt, corner=round, framecolor=redModes] \definesymbol [yes] [{\externalfigure[mpcont.502]}]\definesymbol [no] []\definefield [checkme][check] [setup 3] [yes,no] [no]\field[checkme]</texcode> =Tricks and Traps=

* JS code is was only copied to the PDF if there is was a {{cmd|goto}} referencing one of the defined functions! – This is actually a feature, you can get your JS without {{cmd|goto}}, using the magic incantation <{{code>|used now</code>}}, as in the default value example.(This was fixed.)

* JS code for default values doesn’t work (reported 2015-04-01, still true 2015-10-07); default values are always used verbatim.(Unchecked if this is fixed.)

* There is no <s>{{cmd|setupfields}} </s> (plural)!

\logfields % logs field descriptions to a file fields.log