Structure/Integrity Checker

   Pathagoras can review a source document (whether final or 'under construction') and determine if the document complies with 'the rules' pertaining to proper construction of variables and options/optional blocks. It can also determine if the variables in the document align with the variables in a specified 'mask' (intake form) that is associated with that document.

   Activating the Structure/Integrity Checker:

   1. From the Pathagoras dropdown Features Menu (bottom half), select "Authoring/Editing  | Wizards and Assistants | Structure Checker"


   2. Press Alt-Q and select the pre-assigned "Structure Checker" button (assuming that it has not been reassigned.)

   When selected, Structure Checker will scan the document and analyze each 'Pathagorized' element in the current document (i.e., [variables], <<*Options/Optional*>> blocks, !Groupnames! and {Simplified Options}) and perform the following tasks:

1.It will make sure that all boundary markers are in balance. If Pathagoras detects an imbalance, it will stop and highlight the most likely location where the imbalance exists. (The boundary markers examined are '[' and ']' ,'<<' and '>>' and '{' and '}', unless otherwise assigned.

2.It will check for proper structure of each of your <<*Options/Optional*>> text blocks, including

the proper placement of asterisks around the key terms;

the proper structure of any nested elements;

the proper composition of !group name! and 'prompt' (short question) text;

the proper placement of the final asterisk closing the administrative section of the text block.

3.On request, the Structure checker can create separate alphabetized list the [variables], !groupnames! and *aliases* used in the document being analyzed. That so you can confirm all are spelled correctly and consistently.

If Pathagoras detects a structural error, it will stop and highlight the most likely location of the error.

4. Structure Checker will also ask if you wish to (1) compare the variables in the document with those of a specific mask (intake form) that you have earlier created and saved and (2) against your *Alias* collection. If you answer yes, it will

if variables, ask you to select the mask;

scan the document for the existing variables and aliases and for each found, compare it to those in the mask and multichoice list; and

stop at each variable and alias that does not have a corresponding match so you can decide whether to amend the variable or alias, keep it and/or add it to the mask or alias collection.  (Most likely, the reason why the element is 'missing' is due to a spelling error.)

information   When you initiate 'Structure Checker,' Pathagoras will ask if you want to perform a check on just the displayed document or all documents in the parent folder that contains the initial document. If you select the 'All Documents' option, Pathagoras will not return as many 'ok' messages or identify as many error points as it would if it were checking a single document.  Rather, will simply identify those documents in the parent folder which need attention. After the complete routine has completed, you should return to the document identified as containing a structural error. Then, run the same routine in the individual document and repair as suggested.

   See next page in the Manual for more tools to help you to validate a document.