The dialog to generate the word lists is available through the menu, Tools, Generate word lists.
It generates a general word list, a list of Hebrew words, and one of Greek words.
It goes through all the data in the project, collects the entries which have been marked, and then inserts the lists at a location defined by the user. Thus it can generate a glossary or topical index.
There are three possible lists: a general word list, a Hebrew word lists, and a Greek word list.
For each of these lists there are some options that the user can set:
- Process word list: whether to process this particular word list.
- Add an asterisk to each entry, see below.
- Add the asterisk only to the first time this particular entry occurs in the section, see below.
Generating word lists is simple assuming that the right markers are already in the data: Just set the options, click button OK, and wait till it is through.
The word list generator uses the entries that are in the data to collect the words to insert in the list.
An entry for the general word list is inserted between the \w and the \w* markers. The Hebrew and Greek word lists use similar markers. See the USFM documentation for full details
When the word list generator runs, it will remove any asterisks (*) that were appended to the word. When the option "Add an asterisk to each word entry" has been selected, it will then add an asterisk after the word. If the option "the first time it occurs in a section" has been selected also, it will only add the asterisk where this particular entry occurs for the first time in the section. In this case, if for example the word "talent" occurs several times in a section, it will be given as "talent*" the first time, with the asterisk, and as "talent" the other times, without an asterisk. The section headings define the size of a section.
The lists of words can be inserted once or more than once in the data. The general word list will be inserted between the markers \zopenwordlist and \zclosewordlist. These markers ought to be on a separate line. If this couple of markers occurs in several places, the word lists will be inserted in several places too. If it occurs once, only one list will be generated, and if it does not occur at all, no list will be generated.
Any entries that are already between those markers will be preserved. If there are entries between those markers, and there is no corresponding entry in the text, this entry will be commented out.
List of usfm markers that indicate the position of a word list:
\zopenwordlist \zclosewordlist \zopengreekwordlist \zclosegreekwordlist \zopenhebrewwordlist \zclosehebrewwordlist
The markers that open and close a word list will need to be manually typed in the text at the right location. They are not part of the stylesheet.
Consider the following situation:
The text contains the following general word list entries: Hallelujah, Rabi, Pentecost.
At some place of the data, the list should be inserted, but it already contains some entries:
\zopenwordlist \p Hallelujah: Praise the Lord \p Rabi: Teacher \p Mamon \zclosewordlist
After running the word list generator, it will look so:
\zopenwordlist \p Hallelujah: Praise the Lord \rem Mamon \p Pentecost \p Rabi: Teacher \zclosewordlist
Note the following: (1) the existing entries have been preserved, (2) a new one has been added, (3) one has been commented out, and (4) the entries have been sorted alphabetically.
Note also that any text before the first colon (:) is considered to be the actual entry. If there is no colon, then the whole text will be considered the entry.