Pathagoras Help System

Structure/Integrity Checker

Structure/Integrity Checker

Previous topic Next topic  

Structure/Integrity Checker

Previous topic Next topic  

   Pathagoras can review a source document (whether in final form, or simply 'under construction') and determine if the document complies with 'the rules' pertaining to the 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. Click the "Authoring/Editing Tools" item from the Pathagoras dropdown features menu.

2. Select "General Editing Tools" from the sub-menu. The Editing Tools screen will appear. (See below)

3. Click the "Structure Checking Tools" tab

4. Click the <Check Document Structure> button (fourth from the top).

Click to enlarge

   When the Check Structure button is clicked, Pathagoras will search out each 'Pathagorized' element in the current document (i.e., [variables], <<*Options/Optional*>> blocks 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 checked are '[' and ']' (or other variables boundary markers); '<<' and '>>' (or other options/optional boundary markers); and '{' and '}' (or other simple options boundary markers).
2.It will check for proper structure of each of your <<*Options/Optional*>> blocks, including
the proper placement of asterisks around the key terms;
the proper structure of any nested elements;
the proper composition of any !group names! and 'prompt' (short question) text;
the proper placement of the final asterisk closing the administrative section of the text block.

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

3. It will ask if you wish to compare the variables in the document with those of a specific mask (intake form) that you have earlier created and saved. If you answer yes, it will

ask you to select the mask;
scan the document for the existing variables and for each found, compare it to those in the mask; and
stop at each variable that does not have a corresponding match in the mask so you can decide whether to amend the variable, keep it and/or add it to the mask.

information   When you initiate 'Check Structure,' 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 inspect the document for consistency with structure rules.