{Simple Optional Text} Blocks
Pathagoras provides a 'simplified approach' to providing optional text blocks -- simply surround text you want to be optional with {curly braces}. It is not as 'powerful' as the <<*Optional*>> text blocks (for example, you cannot provide a customized question), but if a simple optional block is all that is required, this is an ideal solution.
Note: The {Simple Optional Text} module is disabled when Pathagoras installs.
You must enable it before you first try to use it.
To create a {Simple Optional Text Block}, place the {Simple Optional Text} boundary markers around the subject text. (Unless you changed the default characters, the boundary markers are "{" and "}".)
Like its 'big brother,' {Simple Optional Text} offers two types of blocks:
| 1. | “Optional” text: This is pure ‘optional text.’ At document assembly time, the program will pause and ask “Include this text?” The user need only select “Yes” or “No” to tell Pathagoras whether the text block should be retained in the final document. |
{The widgets you have ordered are not currently in stock. We will ship them as soon as possible. If we have not shipped within 5 days of this date, you will have the option to cancel the order.} |
| 2. | “Options” text: This ‘type’ allows the user to choose among several options. Each option is separated from the others by a simple, “/OR” (No quotes. Caps mandatory.). At document assembly time, the options are presented to the user on a selection screen. The user selects one or more of the options shown. |
{As per your request, the widgets will be shipped by Federal Express. We will bill you for the extra cost of shipping./OR As per your request, we will send the widgets by standard ground transport. This may take 3 to 5 additional days./OR As per your request, we will hold the widgets for pickup by your courier./OR The widgets you have ordered are not currently in stock. We will ship them as soon as possible. If we have not shipped within 5 days of this date, you will have the option to cancel the order.} |
"/OR" as the separator will present the end user with mutually exclusive 'radio' buttons on the choice seletion screen. If you wish to allow the user to select more than one of the options, separate the choices with "/ANDOR". (No quotes. Caps Mandatory.)
When Pathagoras encounters the optional text block (#1 above), it will highlight the text in the document and ask if you want to keep it (Figure 1).
Figure 1. Optional Text dialog.
If you select <Yes>, the boundary markers are removed
and the text remains in the document.
If you choose <No>, the entire text block is deleted from the document.
When Pathagoras encounters the options text block (#2 above), it will parse out the individual choices and display them onto buttons on a selection screen. (If the text is too long to fit, only the first 200 or so characters of the particular option will display.) Checkboxes are shown at the left of each choice so that you can choose more than one option, if desired.
Figure 2. Options block dialog.
Note that the actual text of the particular option is provided (subject to space constraints.)
You can insert a !Groupname! to the beginning of related blocks of optional text. This will cause each {Simple Optional} and {Simple Options} containing the same !Groupname! to behave in a similar fashion.
Examples:
With Simple Optional text: {!Disclaimer!We disclaim all liability if you try to shave your head with our chainsaw.} (blah blah blah . . .) and furthermore {!Disclaimer!we also disclaim responsibility if you try to use our hedge trimmer to trim your fingernails.} With Simple Options text: We suggest that the color for the living room be {!colors!red/ORyellow/ORburnt orange} and the contrasting trim color be {!colors!yellow/ORpurple/ORroyal blue}. |
Note: When used with an *Options* block of text, the automatic selection of subsequent choices by Pathagoras depends upon the position of the first choice in the list, not its answer. So, in the first above example, if ‘yellow’ (the second option) is selected when the first *options* block is encountered, ‘purple’ (the second option in the subsequent options *block*) will be selected automatically when it is encountered.
Note:The are the same examples used in the section discussing !Groupnames! with <<Optional/Options>>. The differences are the absence of the ability to add a short question or prompt for the end user, and the requirement that '/OR' (instead of just a 'slash') be used to separate choices.
Because of the way that Pathagoras 'reads' the text in order to process it, Word fields (which frequently contain "{" and "}" characters as part of the field code) may cause Pathagoras to act in an unintended manner. If you get such result, 'disable' the simplified {Optional} text block feature. Alternatively, change the character set which identifies 'simple options' within your source text. Test and see if the results improve. If not, contact Pathagoras Customer Service.
A {Simple Optional} text block cannot span more than a single cell of a table. Note: a {Simple Optional} text block can encompass an entire table, but the text block markers surround the entire table, which is not quite the same as spanning multiple cells.