PATHAGORAS Users' Guide, Part 5
Glossaries


  Section F.
"Bulk Add"

     The previous sections of Part 5 discussed definitions and general concept surrounding the use of Glossaries within PATHAGORAS. This section will provide detail on how to create a  glossary, and add terms to it, using Pathagoras'  "Bulk Add" methods.


While the contents of this section of the Guide are still 'valid' and accurate, the information has been reorganized with more illustrations and step-by-step guidance in a MiniManual that can be viewed at this link:

Bulk Add Manual.



Summary:
      Pathagoras allows several methods to move large quantities of already existing text into a glossary or folder of clause. The first method discussed below requires you to 'mark-up' a document into its component clauses. After the 'marking' is complete, it allows you to transfer each designated clause into a new glossary in a single sweep.


     Some preparation of the source document is required, but no codes or programming is required.  The preparation involves only the marking of the beginning and ending points of each of the clauses, and pre-assigning the names and subjects for each clause.
Depending upon the length of the base document, and the number of clauses you will break it into, bulk-adding clauses is probably the faster method for creating a glossary than adding clauses individually.

Bulk Add: A 5-minute tutorial
Actually the length of this tutorial is in direct proportion to the number of clause you intent to markup and add to a new glossary, but 5 minutes is more than enough time to devote to this exercise.

To Mark-Up Text to prepare for a Bulk-Add (automatic mode):
  1. Recall a 'complete' document that you want to break into its component parts to your editing screen.
  2. Optional:
    • Rename this document to "XXXX Master" so you don't overwrite the original.
    • Save this master document in the folder where you wish the glossary to reside. Maybe you have a central glossaries folder, or want to store it in a specific 'subject matter' folder.
    • Create the document's variables right now. (You can do it later if you wish.) Changing personal information (names, addresses, colors, quantities, etc.) to variable terms (e.g., CliName, CliAddress, etc. For maximum flexibility, put brackets around each variable. This will make them instantly 'scan-able' for use in the GotForms? and InstantDatabase modules.
  3. Highlight the section of text that you want to be your first variable. Press <Alt-G>.
  4. At the TermWorks! screen that will appear, click the <Bulk Add> button.
  5. Provide suitable Begin and End markers. We suggest "'<&" and "&>" (no quotes).
  6. Provide a 2 to 4 letter prefix (make it meaningful, but abbreviated. E.g., "con" or "cont" for contacts, or "tr" or "trst" for trusts) and an 'increment'  amount (at least 5 numbers, to leave room to add clauses later on, but it can be anything you want.
  7. Provide the name of the first clause (this sets the initial value to which the incremental value will be added for subsequent clauses).
  8. Click <Mark>. The highlighted text will be appropriately marked up for the later "Bulk Add" routine.
  9. Continue to mark clauses. TermWorks! will highlight the next paragraph and provide for you the next name. Use the arrow buttons on the TermWorks! screen to adjust the length of the highlight for subsequent clauses.
  10. When markup is complete, press the Bulk-Add button.

 
Converting an entire document into a glossary or a folder via "Bulk Add".

    PATHAGORAS is proud of the fact that you use your own documents (formatted the way you like them, using the language you prefer) as the basis for your glossary system. If you have a particular document that you like and want its language to serve as the starting point of your book, you can break the document up into its component parts, and add each component to a book in a 'bulk' fashion. This takes some setup time, but that actually is a good thing.  You don't have to commit your terms to your book until you have checked and double checked the names and subjects you want to assign to each of your clauses. When it is done, click <Go>. All of the terms will be added at one time, and in a matter of only seconds. Here are the specific steps:
1.  Display the document which you would like to 'break up' to create the book of terms. If necessary, copy or move this document into the directory where you want the book to reside. (Pathagoras doesn't really care where anything is, but if the base 'Will' is in your 'client documents' documents folder, that is not the most logical location to store the Will glossary. Copy or move the document to a "WillClauses' folder.)

2. You should rename the document you wish to mark up so that the original is preserved. We suggest including the term "Master" to distinguish it from other documents.
    3.  Spend some time preparing your document. Make sure that the spelling and formatting are correct.

    Certain paragraphs of your base document may not be number or gender neutral. There are four distinct ways to handle this:

           a. Leave it alone. After you have assembled your document, do a search and replace for each incorrect word ('him' for 'her', 'he' for 'she', etc.). This is the standard (pre-Pathagoras) way of doing such things. This is a perfectly acceptable method of doing things as far as Pathagoras is concerned.  However, once you have gotten a taste of Pathagoras' functionality and "neat tricks," you may want to try one of the remaining methods.

           b. You can substitute a gender/number word with a unique 'code' each time it appears. The GotForms? module is perfect for this because the 'code' can be a simple set of brackets or even an underline.  Once the document is assembled, simply scan (press <Alt-S> for the brackets and underlines. 


                Or, if you might want to save and reuse personal data for a client, you may wish to use the InstantDatabase features. If you consistently 'code' your various documents and clauses (e.g., every place a certain bit of information should go is  noted by the identical variable name), you can create an "Instant Database" mask. With Instant Database, you can search and replace up to 30 items in one sweep. You can also create and save Instant Database 'masks' (a coding key) so that you do not have to repeat the typing steps for the S&R. Just click and go. And with InstantDatabase (s the name implies) you can save out clients' and customers' personal data to use again with a similarly coded document.

           c. You can duplicate the clause, and hard code each variation.. You end up with multiple instances of similar, but not identical clauses. One paragraph for male, another female, one for a family with one child, another for 'children' and yet another for 'no children.'  It doesn't matter how many varieties of clauses you have. Name the clause (when you get to that step) with a slight variation of the base name to indicate the differences among them. (e.g., 'boc103m' for the male version, 'boc103f' for the female, etc.). When the clauses are displayed in the checkbox form, just choose the correct version. 
          d. You can put Word's "Ask" and "Fill-in" fields at the appropriate locations. Or use your database (when you decide to make that step) to complete the text with database fields (or words based on database fields.) Once you get very advanced with this stuff, this is probably the 'best' way of doing sex and gender completion throughout a document (especially since there are many variations on a sex--just because you know the sex, you don't necessarily know the context. A "female" reference is not just "she," but "her", "woman", "mother", "aunt", "Testatrix", etc.) . However, creating fields is no doubt the most complicated of these options. While the "big guys" (HotDocs and ThinkDocs) work with you extensively on this, it is not a part of the Pathagoras package. Why?--simply because of its complexity and variety. (Field creation right out of the box is the main reason why people give up on these ultra-sophisticated programs. Pathagoras suggests you wait. Eventually you might decide to do this, but for right now, choices b and c are perfectly good options.) 

      Don't go too crazy at this point about de-gendering and de-numbering. It is better to start with something, even though it may not be everything you want, and see the result than to spend hours trying to perfect the idea. Adding more clauses after the initial creation of the glossary is a piece of cake.  Plus, one the glossary is created, Pathagoras provides a simple method for duplicating and renaming glossary terms so that editing, refining and maintaining the glossary is as easy as editing an ordinary document.

    4.  Highlight the first section of your document (this can be a line, a paragraph, several paragraphs; your choice). Press the <Alt-G> hot-key combination. The TermWorks! screen will appear. (NOTE: The TermWorks! screen will be discussed in much greater detail toward the bottom of this section the Guide.) Press the Bulk Add button (rightmost blue button) and you will see the following:
    Bulk Add works by either you (or using the above screen, Pathagoras) putting unique 'begin' and 'end' codes at the top and bottom of each clause. You must also provide a clause name and subject (see more information on this below).

    I use “<&” to mark the beginning of a clause and “&>” to mark the end.  You can use any characters you want. Just be sure that the characters you select don't appear naturally in the document.
    Complete the '1st clause name' box  and provide a 'description' or  'subject' for the clause where indicated. Press the <Mark> button. When press <Mark>, Pathagoras surrounds the highlighted text with the designated begin and end markers. It then names the clause and types in the subject provided by you between appropriate slash separators at the beginning of the clause. Pathagoras then highlights the next paragraph in the document. It proposes the next name based on the prefix and the increment you provided. All you need to do is provide the Description/Subject. Here are some additional specifics you must know, followed by an example.
 a. Name: Pathagoras suggests that the clause names follow a very simple “prefix/suffix” pattern (such as ‘will100', 'wil110', 'wil133', etc.). The reason for this will become more apparent when you begin to display your work onto the CheckBox Form or recalling them 'mouselessly' directly from the keyboard. If you decide you do not like your names, you can later rebuild the glossary with “better” names, but try it this way to begin with.  See a fuller discussion of the 'Prefix/Suffix Naming Convention' in Part 4 (Document Assembly) of this Users' Guide.

In any event, the name must begin with a letter, and contain only letters and numbers. The only exception to the letters and numbers rule is that the name may contain an underline (‘_’) character. The name may not contain any spaces.
      b. Subject: Here you can have it your way, to 'make up for', as it were, the fact that the name may not be meaningful. The 'subject' description should still be relatively short (no more than 30 characters), but can in fact be of any length. As with all aspects of Pathagoras, don't spend too much time worrying about the subject. Changing it if you find the need is a very simple process. 

      For a document to be 'properly marked' for Bulk Add, the name of the clause must begin immediately after the ‘begin’ mark and must end with a forward slash (‘/’). The subject of the clause must begin immediately after the slash following the name, and must also be closed by a forward slash (‘/’).  The 'end mark,' of course, must be placed at the end of the desired clause.

Details and an example:
      The first clause, of your basic document  might currently look like this:
    LAST WILL and TESTAMENT
    of 
    JOHN PAUL DOE

        I, JOHN PAUL DOE, SSN: 456-78-9012, being of sound and disposing memory, do hereby declare this writing to be my last will and testament, revoking any previous Will which may have been make by me.

    A.  I am married and have two children. My wife's name is RoseMary Doe, and my children's names are Robert Doe, Alan Doe and JoAnne Doe.

    B.  I direct my hereinafter named Personal Representative to pay all of my just debts and final expenses.

        After neutering the document, and marking out the various clauses with begin and end marks, and assigning names and subjects, the document being prepared for "Bulk Add" might look like this. Using TermWorks!, the marking can be done automatically. You can do it manually by typing the begin and end marks at the appropriate places, and adding the term name and subject at the beginning of each clause to be added.:

    <&will100/Preamble to Will/LAST WILL and TESTAMENT
    of 
    [CLINAME]

        I, [CliName], SSN: [SocSecNo], being of sound and disposing memory, do hereby declare this writing to be my last will and testament, revoking any previous Will which may have been make by me.&>

    <&wil110/Family:Married 2+ children/A. I am married and have [NUM_CHDN] children. My spouse_type's name is [SPOUSE_NAME], and my children's names are [CHDN_NAMES].&>

    <&wil120/Payment of Debts/B.I direct my hereinafter named Personal Representative to pay all of my just debts and final expenses.&>

                        NOTE: the color coding seen above is for emphasis only.  It is not required for preparation of your
Bulk-Add master document.  TermWorks! will, however, color code the entries
so as to make it easier to distinguish the begin and end markings from the text to be added.

    While you need not spend a lot of time creating names and subjects (they are easy to change later on), do spend a bit of time making sure that each named clause follows the above rules. There is an automated checking feature built into Pathagoras, but it is still much faster to get the names correct beforehand.  Use the TermWorks! BulkAdd screen to help you keep track of you numbering. You can even tell Pathagoras how much you want to increment each new term by.

    6.  To Bulk-Add the document you have prepared, click the small "BulkAdd" now button  at the right side of the TermWorks! Bulk-Add screen. Follow the prompts. 

    7.  After the routine has gone through its paces. Pathagoras will ask you if it should automatically attach your newly created glossary as a book in the first available slot in the active Document Assembly library. You should. If you want to attach it to another library, you will be given that option as well.

    Test your new glossary by pressing the Document Assembly button. You will see your new glossary in the library. Double click on the option circle to display the checklist.

    And don't forget to try out the <Alt-G> function against your newly created glossary.  Type a glossary clause name at the left edge of an editing screen. Press <Alt-G>. After a brief search period, the term will be instantly inserted into your document.



       "Folder Add" method. Perhaps a folder already contains clauses that you have been using for document assembly.  Or you have a few clauses within a folder that you wish to move into a glossary because of the know advantages of working with glossaries (power, speed, edibility and transportability)  Pathagoras allows a simple way to add all or a portion of a folder of files into a glossary. It is very quick, and it is very simple. Here's how:

1.  Choose the "Convert Files to Glossary" option from the 'Utilities/Settings' screen (found in the Pathagoras drop-down menu

2.  If your clauses are already a book (as suggested in the first sentence, maybe you previously assigned a collection of documents in a folder to one of your document assembly books), choose option #1 when presented. If you wish to create a new book/glossary 'from scratch', choose option #2. (With option #2, you can also choose whether to convert .doc, .dot, .txt, .rtf and even .wpd files into your new glossary. However, you can convert only one type of file at a time.)

3.  Follow the prompts to name the glossary and when the checkbox screen displays, choose which of the files in the directory you wish to move into the glossary.

NOTES: The name of the specific document/file that is currently being moved into the glossary will be proposed as the name of the glossary clause. However, all 'bookmark naming rules' (no spaces or non-alphabetic/numerical characters) are in effect during the transfer process. Therefore, if the name of the file does not meet the bookmark naming rules, you will be prompted for a proper name.  (Even in this step, Pathagoras is very helpful. Pathagoras will automatically propose a better name for you.)


Bulk add a Folder to Glossary

     Another program tool allows you to move the contents of an entire folder into a glossary. Let's assume that you had a folder of clauses that you regularly drew text from, and you know want to move the separate documents into a single glossary.
Using this technique, you can quickly move vast quantities of text existing in separate files into a single glossary.

     Click the Glossary Tools button from the Pathagoras dropdown menu. Select the appropriate function.  You will be provided choices including importing the entire folder, or just selected documents. You can import Word documents, text files, 'rtf' files or WordPerfect files. 

     If you are converting Word documents into a glossary, the subject that you may have previously assigned to the document will automatically be carried forward as the subject for the new glossary term.  If you never assigned a subject, then the full name of the document will become its subject. Because of naming conventions required for glossaries (the term name may contain only letters and numbers and no spaces,  some name conversion may be required. Pathagoras will help where it can (e.g., putting underlines in place of spaces), but you may be called upon to make some decisions.

     Once the bulk add is complete, you should carefully review the content of the new glossary. Edit where appropriate, rename and duplicate clause where needed.  Just be mindful of the bookmarks when editing, and stay within them. Any text outside of a bookmark is not included in any glossary call.




   Once you begin to use the glossary and appreciate its power, you will want to add new clauses, duplicate others, rename or reposition others. Pathagoras helps you at each step. See the beginning portions of this part of the Users' Guide for instruction on how to create and add clauses to a Glossary.

Part 5a discusses Glossaries in general.
Part 5b of this discusses creation of glossaries and adding terms 'one at a time.'
Part 5c discusses Simple List glossaries.
Part 5d provides detailed guidance regarding the Glossary Functions screen.

Part 5
g  discussed the use and benefits of a 'General Glossary'.

View Introduction (Part 1).
View Part 2 of Users' Guide (PathSmart module)
View Part 3 of Users' Guide (SaveSmart module).
Return to Part 4 of Users' Guide (Document Assembly module).
View Part 6 of Users' Guide (Database Linking module)
Continue with Part 7 of Users' Guide (Other Features).