Anatomy of 'Variables' and 'Optional Text' Structure

Here is a collection of the various character sets for marking variables and optional text. They are listed from the simplest to the most complex:

informationThe boundary and other colorings that you will see in the text markers below is for emphasis only. No marker coloring is required.

The anatomical discussion of each example is set out in blue:

VARIABLES:

Simple variable: [Client Name];[quantity] Anatomy: Two inward facing square brackets (the boundary characters) surrounding a core term. The core term can one word or a short phrase or itself can have structural components

Multiple choice variable: [chocolate/vanilla/strawberry] Anatomy: A simple list of optional terms within variable boundary characters. Each choice separated by a forward slash.

MultiChoice variable (alias): [*States*]; [1st stop *States*]; [second stop *States*]. Anatomy: Regular variable structure. The two asterisks indicate the call to an '*Alias* List' An *Alias* List is a series of optional values (in this case the 50 United States) stored in a separate Excel file. Note that the same alias term can be used within multiple variables. The additional text is what distinguishes each from the other.

Titled variable: [Special Order:Yes/No/Not Applicable]  . . . [Priority Mail:Yes/No/Not Applicable] Anatomy: Regular variable structure. The 'title' is typed immediately after opening boundary character and 'closed' by the colon. Titles can be used for simple or multiple choice variables to assist user as to what the specific variable (which otherwise is identical to another variable) references.

Grouped variables: [!client!he/her/they] . . . [!client!his/hers/theirs] Anatomy: Regular variable structure. The 'groupname' is typed immediately after the opening bracket between '!' (exclamation marks). A groupname is used to tie two or more variables together. (The positional selection of the first variable automatically causes the same positional selection of subsequent variables. Groups used only for multiple choice variables)

 

OPTIONAL/OPTIONS TEXT BLOCKS (simple)

{Shipping included in cost} Anatomy: Two facing curly braces (the boundary characters) surrounding a core term. The core term can range from a single character to multiple paragraphs. When encountered, Pathagoras will highlight the text and ask if you want to keep or delete.

{!shipinfo!Shipping included in cost.} . . . {!shipinfo!Remember shipping charges have already been included in the list cost of the product.} !Anatomy: Two facing curly braces (the boundary characters) surrounding a core term. The 'groupname' is typed immediately after the opening brace, between '!' (exclamation marks).The core term can range from a single character to multiple paragraphs. The !group! used to tie two separate blocks together. The selection or rejection of the first encountered member of the group results in the same action for the remaining members of the group.

{Shipping included in cost/ORShipping Costs Extra} Anatomy: A simple list of optional terms surrounded by the boundary characters. Each option separated by the characters "/OR" (no quotes, but the capital 'OR' is mandatory). To allow multiple selections, use /ANDOR as separator.

{*States*} Anatomy: Regular options structure, except the the two asterisks indicate the call to an '*Alias* List' which provides the various choices. (An 'alias' list is a series of optional values (in this case the 50 United States) stored in a separate file and referenced by a simple 'alias.' The core term is the alias and it is surrounded by the boundary characters.

 

Introduction: OPTIONAL/OPTIONS TEXT BLOCKS ('robust')

   The setup for Pathagoras' more robust <<*Options*/*Optional*>> text blocks shown below is not without its complexities. Compared with the setup required by competitive programs, however, it is undeniably simpler. Because it is plain text, you don’t have to fish around for the right field coding and switches. Seen ‘on screen’ when the source text is recalled, it actually becomes quite 'readable' once you become familiar with the 'anatomy.'

   The precise placement of the various characters that make up the blocks is mandatory. Not to worry too much, however. Pathagoras provides tools (1) to automate the creation of <<*Options*/*Optional*>> blocks and (2) to check the structure of each block after they have been created.

   The 'call to action' is the key term in the text block that tells Pathagoras what to 'expect' from the remaining sections of the text block. It will be either Optional, Options or Options(radio).

   The 'administrative section' is that part of the text block that contains the 'call to action' and the group and display information. It does not remain in the final assembled document.

 

OPTIONAL TEXT BLOCKS (robust)

Basic:

 <<*Optional*You may also pick up your block of cement from our help desk between the hours of 9 a.m. and 5 p.m.>> Anatomy: Two sets of 'facing' angle brackets (the boundary characters) surround the core block. The red is only for emphasis. The word “Optional” surrounded by asterisks constitutes the 'call to action.' The actual optional text can range from a single character to multiple paragraphs. Don’t forget the closing brackets at the end of the block.

With question:

 <<*Optional*Is pickup available?*You may also pick up your block of cement from our help desk between the hours of 9 a.m. and 5 p.m.>> Anatomy: Boundary characters surround the core block. The word “Optional” surrounded by asterisks constitutes the 'call to action' followed immediately by the prompt or question that you want to be shown to the end user during document assembly. A third asterisk closes out the 'administrative section' of the block. The actual optional text can range from a single character to multiple paragraphs.

With !Group! (A !group! name is used to tie two blocks together. The selection or rejection of one member of the group results in the same action for the remaining members of the group.):

 <<*Optional*!pickup!*You may also pick up your block of cement from our help desk between the hours of 9 a.m. and 5 p.m.>> (body text . . .body text)

       <<*Optional*!pickup!*Be sure bring a crane with you.>>

Anatomy: Boundary characters surround the core block. The word “Optional” surrounded by asterisks constitutes the 'call to action.' The 'groupname' is typed immediately after the call to action between '!' (exclamation marks). A third asterisk closes out the 'administrative section' of the block. The actual optional text can range from a single character to multiple paragraphs.

With !Groups! and Question/Prompt:

 <<*Optional*!pickup!Is pickup available?*You may also pick up your block of cement from our help desk between the hours of 9 a.m. and 5 p.m.>> (body text . . .body text)

       <<*Optional*!pickup!*Be sure bring a crane with you.>>

Anatomy: Boundary characters) surround the core block. The word “Optional” surrounded by asterisks constitutes the 'call to action.' The '!group! name' is typed immediately after the call to action between '!' (exclamation marks) followed immediately by the prompt or question that you want to be shown to the end user during document assembly. A third asterisk closes out the 'administrative section' of the block. The  actual optional text can range from a single character to multiple paragraphs. (The prompt would appear only in the first instance of the group. It does not need to be repeated in subsequent members of the group.)

 

OPTIONS TEXT BLOCKS (robust)

   Basic:

<<*Options*I have no children./I have one minor child./I have [num cdn] minor children.>>

Anatomy: Two sets of 'facing' angle brackets (the 'boundary' characters) surround the core block. The word “Options” surrounded by asterisks constitutes the 'call to action.' The various choices are separated by forward slashes. The actual text of the options will appear as the 'prompts' on the selection form during document assembly process.

 

  With reference to *Aliases*

<<*Options**States*.>> Anatomy: The 'boundary' characters followed by the call to a 'MultiChoice List' alias.

With Prompts/Questions (up to 6 choices and 6 responses)

<<*Options*No children/One child/Two or more children?* I have no children./I have one child to whom I give, devise and bequeath the remainder of my estate./I have [number of children] minor children to whom I give, devise and bequeath the remainder of my estate, in equal shares.>> Anatomy: Boundary characters surround the core block. The word “Options” surrounded by asterisks constitutes the 'call to action.' The optional term '(radio)' is included in this call to action to indicate that the choices are mutually exclusive. The call to action is followed immediately by a series of prompts or question that you want to be shown to the end-user during document assembly. A third asterisk closes out the 'administrative section' of the block. The options text follows, each option separated from the other by forward slashes. Each option can range from a single character to multiple paragraphs.

With !Group! (A !group! name is used to tie two blocks together. (The positional selection of the first variable automatically causes the same positional selection of subsequent variables.):

<<*Options*!Children!*I have no children./I have one minor child./I have [num cdn]  children.>>

<<*Options*!Children!*I give the remainder of my estate to the following persons./I give the remainder of my estate to my child./I give the remainder of my estate in equal shares to my children, per stirpes.>>

Anatomy: Boundary characters surround the core block. The word “Options” surrounded by asterisks constitutes the 'call to action.' The '!group! name is typed immediately after the call to action between '!' (exclamation marks). A third asterisk closes out the 'administrative section' of the block. The actual options text, each separated from the other with a forward slash, can range from a single character to multiple paragraphs.

 

With !Group! and Questions/Prompts:

<<*Options*!Children!No children/One child/Two or more children*I have no children./I have one minor child./I have [num cdn] minor children.>> 

<<*Options*!Children!*I give the remainder of my estate to the following persons./I give the remainder of my estate to my child./I give the remainder of my estate in equal shares to my children, per stirpes.>>

Anatomy: Boundary characters surround the core block. The word “Options” surrounded by asterisks constitutes the 'call to action.' The '!group! name is typed immediately after the call to action between '!' (exclamation marks) followed immediately by the prompts or questions that you want to be shown to the end user during document assembly. A third asterisk closes out the 'administrative section' of the block. The actual options text, each separated from the other with a forward slash, can range from a single character to multiple paragraphs. (There must be as many prompts as there are actual choices. The prompts would appear only in the first instance of the group. They do not need to be repeated in subsequent members of the group.)