Difference between revisions of "Widgets"
(add link to Midgard_PC_sheet) |
(Comments about defiencies in MkIV, information about JavaScript in Acrobat) |
||
| Line 20: | Line 20: | ||
\goto {advance by one} [JS(increment)] | \goto {advance by one} [JS(increment)] | ||
</texcode> | </texcode> | ||
| + | |||
| + | '''Beware''', in MkIV (as of 2015-04-01) the JS code is only copied to the PDF if there is a \goto referencing one of the defined functions! | ||
You can pass values to a JS function: | You can pass values to a JS function: | ||
| Line 36: | Line 38: | ||
* JS_V_n, JS_S_n, JS_R_n are the names of the variables | * JS_V_n, JS_S_n, JS_R_n are the names of the variables | ||
* JS_N keeps the number of arguments | * JS_N keeps the number of arguments | ||
| + | |||
| + | == Documentation == | ||
| + | |||
| + | JavaScript in Acrobat is different than in a web context. Documentation is even more sparse that on ConTeXt ;) | ||
| + | Debugging is only possible in Acrobat Pro, and also there very inconvenient. | ||
| + | Additionally, Acrobat’s possibilities change with every version. | ||
| + | |||
| + | * [http://www.adobe.com/devnet/acrobat/javascript.html JavaScript documentation at Adobe’s] | ||
| + | * [http://help.adobe.com/livedocs/acrobat_sdk/9.1/Acrobat9_1_HTMLHelp/wwhelp/wwhimpl/js/html/wwhelp.htm?href=JS_Dev_Tools.72.1.html&accessible=true JavaScript API Reference for Acrobat 9] | ||
=Fields= | =Fields= | ||
| Line 58: | Line 69: | ||
Beware, for fillinfields in MkIV you need {{code|\usemodule[fields]}}! | Beware, for fillinfields in MkIV you need {{code|\usemodule[fields]}}! | ||
They’re meant for clozes (texts with gaps, like in questionnaires). | 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 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. | Other fields you must first define 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. | ||
Revision as of 08:07, 2 April 2015
< Visuals | Interaction >
You can find more about interactive form elements in Widgets uncovered. It’s written for MkII, but still mostly valid.
At the moment all of the following examples are from mwidget manual. We will cook up our own later.
Contents
JavaScript
If you need 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 this section.
\startJSpreamble {name} MyCounter = 0 ; \stopJSpreamble \startJScode {increment} MyCounter = MyCounter + 1 ; // or: ++MyCounter ; \stopJScode \goto {advance by one} [JS(increment)]
Beware, in MkIV (as of 2015-04-01) the JS code is only copied to the PDF if there is a \goto referencing one of the defined functions!
You can pass values to a JS function:
\startJScode {increment} MyCounter = MyCounter + JS_V_1 ; \stopJScode \goto {advance by five} [JS(increment{V{5}})]
- V{} is verbose, defaults to string
- S{} = as string
- R{} = as reference
- JS_V_n, JS_S_n, JS_R_n are the names of the variables
- JS_N keeps the number of arguments
Documentation
JavaScript in Acrobat is different than in a web context. Documentation is even more sparse that on ConTeXt ;) Debugging is only possible in Acrobat Pro, and also there very inconvenient. Additionally, Acrobat’s possibilities change with every version.
Fields
 |
Someone thinks this entry needs some more explanation. | (See: Needs Explanation?, To-Do List.) |
Relevant commands:
- \setupfield, \setupfields
- \definefield[name][type][setup name][content values][default content]
- \field[name]
- \fillinfield
- \fillinline
- \fillintext
- \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 \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 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
\fillinfield[name]{text that defines field length}
or
\setupfield[ShortLine][horizontal][width=2cm] \definefield [Email] [line] [ShortLine] [] [sample@contextgarden.net] \field [Email] [your email]
Radiobuttons
Sample from the manual:
\setupfield [LogoSetup] [width=4cm, height=4cm, frame=off, background=screen] \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}
Checkboxes
\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]
Tricks
This helps debugging (MkII only!):
\tracefieldstrue \showfields % typeset a table of field relations \logfields % logs field descriptions to a file fields.log
Samples
- Midgard PC sheet (RPG character sheet with lots of text fields in tables)
