<<*Optional*>> Text Blocks

<<*Options/Optional*>> text blocks are sections of text within a source document which allow the end user tremendous flexibility as to what text in the source will remain in (or deleted from) the final document.

While <<*Options/Optional*>> text blocks are easy to create manually following the instructions provided on this page, they can be built automatically using the
Variable Creation Assistant.

Any of the below text blocks can be copied and pasted into any Word document. To test the action of the <<*Options/Optional*>> routine, place the cursor in your Word document immediately to the right of the closing bracket and press Alt-G.

Click here: www.pathagoras.com/sample for an extensive collection of *Options/Optional* text blocks which can be copied into a Word document and processed.

Two types of optional text blocks are used in Pathagoras. Both are easy to create. They are denoted by plain-text boundary markers “<<” and “>>” placed around the subject text. The introductory word *Optional* or *Options* distinguish one from the other.

“Optional” text: This is pure ‘optional (take it or delete it) text.’ It is sometimes called 'conditional' text. At document assembly time, the program will pause and ask “Include this text?” (or such other question as the user provides). The user need only select “Yes” or “No” to tell Pathagoras whether the text block should be retained in the final document.

<<*Optional*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.>>

“Options” text: This block ‘type’ allows the user to select among several choices. Each choice is separated from the others by a simple, plain text slash (“/”). At document assembly time, the choice are presented to the user on a selection screen. The user selects one or more of the displayed choices.

<<*Options*As per your request, the widgets will be shipped by Federal Express. We will bill you for the extra cost of shipping./As per your request, we will send the widgets by standard ground transport. This may take 3 to 5 additional days./As per your request, we will hold the widgets for pickup by your courier./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.>>

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 option text is provided (subject to space constraints.)

Notes: For those who are familiar with HotDocs®, GhostFill® (and most other document assembly programs), the ‘Optional Text’ concept is akin to what is used by 'templates’ in those programs. You will likely find that Pathagoras’ <<*Optional Text*>> is easier to use because the coding involved in a HotDocs/Ghostfill template is simply non-existent in Pathagoras.