SetupDesignGuide.pdf - Firmware Encoding Index

Setup Design Guide
DRAFT
4.2.18 goto
endpassword;
minsize = 6,
maxsize = 20,
encoding = 1,
This command allows the user to jump to a new page. In terms of HTML operations, this behaves
exactly like a hyper-link. The target for a goto command is going to be a form.
Example: goto formid PAGE_ONE,
4.2.19 grayoutif
prompt = STR_GOTO_PAGE_ONE;
The grayoutif tag causes the following tag to be displayed in a special display form used for
inaccessible options if the Boolean expression evaluates to true. Those writing IFR should realize that
different browsers will support this option to varying degrees. In particular, HTML has no similar
construct so may not support this facility.
Example: grayoutif NvRamMap.MagicNumber == 3;
4.2.20 suppressif
The suppressif tag causes the following tag to be hidden from the user if the Boolean expression
evaluates to true. As with grayoutif, the quality of support may vary from browser to browser.
HTML does not itself have a mechanism to provide this functionality.
Example: suppressif NvRamMap.SerialPortCount == 0;
4.2.21 hidden
Hidden input allows for communication of things like revision data between the creator of the VFR and
the consumer. The user should not generally see hidden tags. Hidden tags can be used inside VFR
along with the grayoutif and suppressif tags to control display of optional data.
Example: hidden
4.2.22 inconsistentif
varid = NULL.CurrentIfrVersion,
value = 2;
This tag uses a Boolean expression to allow the creator of the IFR to check options in a richer manner
than provided by the question tags themselves. This tag may be used to e.g. validate that two options
aren’t using the same address or that numbers entered align to some pattern (like leap years and
February in date input). The tag provides a string to be used in a “pop-up” display to alert the user to
the issue. Inconsistency tags may be evaluated when the user traverses from tag to tag or only upon
submission. The user should not be allowed to submit the results of a form inconsistencies.
Example: inconsistentif
endif;
prompt = STR_ERROR_POPUP,
ideqval NvRamMap.TestValue == 2,
36