WIZARD

You can use the statement WIZARD to present the end-user with the Content Wizard where Text Blocks can be selected.

To run a Master Template containing this feature, use KCM ComposerUI for HTML5.

The following is the definition.

WIZARD id
  NAME path
  FOLDER path
  SELECTION_INPUT map
  SELECTION_OUTPUT map
  SUPPRESS_EDITABLE_TEXTBLOCKS
  SUPPRESS_QFORMS
  SHOW_ALL
  NON_INTERACTIVE
  DATA_DEFINITION NONE
  VIEWS_USE_ORDERING

The WIZARD statement has a different behavior for the Word and AiaDocXML outputs.

Word output: The statement produces data identified by the label id. This data can be turned into Word output with the FOREACH WIZARD/NODE statements.
AiaDocXML and HTML output: The output is produced directly.

The label id identifies the Content Wizard for later use with the statement FOREACH WIZARD (see FOREACH WIZARD/NODE). If multiple Content Wizards use the same label id, the statement FOREACH WIZARD used the data from the last occurrence.

If the following descriptions do not state that a keyword is optional, it is mandatory.

NAME specifies the Content Wizard path presented to the end user.

FOLDER specifies that the user can choose a Content Wizard from the Content Wizard path or its subfolders. If there is only a single choice possible, the selection screen is suppressed and the choice is made automatically. If a Title property is configured in KCM Designer for the Content Wizard path, it is shown as the title of the selection screen.

NAME and FOLDER are mutually exclusive. One of the keywords must be specified.

The path parameters are paths to the appropriate objects in KCM Designer. This path must include all containing folders separated by backslashes.

SELECTION_INPUT specifies a map that contains a set of overrides that are applied to the Content Wizard before it is presented to the user. This keyword is optional. If no map is specified, the defaults as specified by the editor of the Content Wizard are used.

SELECTION_OUTPUT specifies a map that receives a list of the state of each item that was presented in the Content Wizard. This keyword is optional.

SUPPRESS_EDITABLE_TEXTBLOCKS prevents the Content Wizard from showing any Editable Text Blocks that are otherwise presented to the user based on the selected Text Blocks. This keyword is optional.

NON_INTERACTIVE specifies that the Content Wizard should be run in a non-interactive modus. This keyword allows Content Wizards to be used in batch environments. The Content Wizard selects all default values for the Content Wizard, suppresses the editing of Editable Text Blocks, and selects all default values in the associated QForms. If the defaults do not satisfy constraints on the QForm or on the Content Wizard, such as the number of selected Text Blocks, an error is reported, and the Master Template stops.

DATA_DEFINITION specifies a variable that can be used as Data Definition when representing repeating structures in the Content Wizard. Currently, only the value NONE is allowed.

VIEWS_USE_ORDERING indicates that Text Block multi-selects that are based on a Text Block List should be presented as an ordered list. This feature gives the user the ability to reorder the Text Blocks. This keyword is optional.