<<*Ask*>> Elements |
|
|
|
|
||
<<*Ask*>> Elements |
|
|
|
|
|
<<*Ask*>> Elements |
|
|
|
|
||
<<*Ask*>> Elements |
|
|
|
|
|
|
|
||
An <<*Ask. . .*>> prompt requires the following elements:
| • | Opening '<<' and closing '>>' to designate the scope of the prompt. (Remember: the red and blue colors used in these examples is not important. We add color only for emphasis and clarity.) |
| • | The term "*AskOptions*", "*AskOptional*", "*AskRepeat*", "*AskValue*" (depending upon the nature of the prompt) followed by the !group! name. Of course, this group name will relate the answer to the ask prompt to Options/Optional blocks in the body of the document. |
| o | <<*AskOptions*>> blocks: list the choices you want to present to the end user. Separate each choice with a '/'. Close the list with a '*'. E.g., <<*AskOptions*!shipmethod!FedEx/UPS/USPS*>> and later in the document: Your order will be sent by <<*Options*!shipmethod!Federal Express (2 day delivery/United Parcel Service (ground; allow 4 days for delivery/US Postal Service (1st class mail).>> |
| o | <<*AskOptional*>> blocks: pose the question that you want the end user to answer. Close the question with a '*'. E.g., <<*AskOptional*!freeshipping!Will shipping be free*>> and later in the document <<*Optional*!freeshipping!*Plus, if you place your order in the next 30 days, your shipping is free!>> |
| o | For <<*AskRepeat*>> blocks, pose the question that you want the end user to answer. Close the question with a "*". E.g., <<*AskRepeat*!NumCdn!*How many chilren?>>  See discussion on how Pathagoras handles the repeats 'count' with Options blocks beginning this page of the Manual. |
| o | For <<*AskValue*>> blocks, you can ask a question that you want the end user to answer. Close the question with a "*". E.g., <<*AskValue*!Score!*>> or <<*AskValue*!Score!Test Score?*>> and later in the document <<*Options*!Score!0-59/60-69/70-79/80-89/90-100*F/D/C/B/A>> |
Note the placement of the administrative "*" (asterisks). Just like in a regular <<*Options/Optional*>> block, the stars close the administrative section. The administrative section includes any questions that are posed. (As used in Pathagoras, the 'administrative section' of a prompt is set apart by "*s"from the text that is intended to remain in the document. In an <<*Ask*>> block, it is all 'administrative text' since none of it remains in the document.)
Each Ask prompt must reside on its own line. It cannot reside on the same line as another Ask prompt, nor can any other text be combined with it.
The Ask prompts, collectively, constitute the Interview phase of document assembly. Ask such, the prompts should appear at the top of the document, or in a separate document that was written solely for purposes of conducting an interview and calls on other documents or building blocks in response to the interview answers. You should avoid interspersing Ask prompts within the document body. Pathagoras will likely not crash if you do, but it is not considered a best practice.