Maintaining the Glossary

This document is intended for Premium line staff responsible for maintaining this glossary. These instructions explain basic glossary maintenance and discuss naming and formatting conventions. 

If you entered this page to request a glossary change or addition, please do so with the Requesting Changes/Additions form.

Add a New Term to the Glossary

Adding a new term involves three steps:

  1. Add the new term and definition to the appropriate glossary file.
  2. Optionally, add a picture for use with the term.
  3. Add an entry to the table of contents file and a link to the definition.

Each step is explained in detail below.

Add the Term to the Appropriate File

Introduction

Because of the size of the glossary, terms/definitions are stored in multiple files. The term/definition files are located in folder .../terms/html. The files are named for the letter ranges they contain. For example, file aa_am.htm contains terms that start with "aa" through "am."

   To add a new term

1. Open the desired file.
2. Find a term/definition with a format similar to the one you are creating. Select the term and definition. Include the bookmark, and any other components you need (picture icon, magnifying glass icon, See and See also references, etc.). Copy it using the Windows copy function.
3. Paste the term and definition in its proper place in alphabetical sequence.
4. Enter your term and definition. Note the following conventions:

For terms with acronyms: Create entries for both the term and the acronym. Enter the definition under whichever is most commonly used at Premium line. A definition should occur only once in the glossary. For all synonyms that do not contain the definition, enter a See hyperlink to the term that contains the definition.

If the acronym has the definition, begin the definition with the spelled out term. See SIMM as an example. Place a link to the acronym in the spelled out version. See Single Inline Memory Module as an example.

If the spelled out term has the definition, place the acronym in parentheses after the term.  See Single Pole, Double Throw as an example.

For terms with multiple definitions: Number each definition using the Numbered List paragraph style. See Signal as an example.

5. Insert See also hyperlinks.

See also hyperlinks point to supplemental or related information about the term. See SCC as an example.

6. Insert hyperlinks to the Premium line web site.

When you mention Premium line products in the glossary, you may want to add a hyperlink to the product area of the Premium line web site. Insert the magnifying glass icon (.../system/images/detail.gif) and point the link to the page on the Premium line site. See SPOX as an example. 

The magnifying glass icon should be placed after the eye icon, if there is one. Otherwise, place it after the term, preceded by one space.

Note: Hyperlinks to the Premium line web site must be added in such a way that they also work on Premium line. If you need help with this, contact the Premium line web staff.

7. Create a new bookmark using the naming convention below.

Bookmark names should be the same as the definition name, with the same case. However, for all special characters, including spaces, substitute the "_" (underscore) character.

Add an Image to Illustrate the Term (Optional)

Introduction
Images are stored in separate html files to improve glossary performance. The images themselves are located in folder .../terms/images. The html files that display the images are located in folder .../terms/img_html.

For an example of this functionality, see Blind Mating.

   To add an image

1. Create the image as a GIF or JPEG file and store it in .../terms/images.

Naming conventions: There are no formal naming convention for images. Use a name that associates it with the term. DO NOT exceed eight characters for the file name. Use lower case characters only. Replace all special characters, including spaces, with the "_" (underscore) character.

Image dimensions: Images should be no more than 350 pixels wide, and of any height. 

2. Create a new html file for the image. The best way is to copy an existing file from the .../term/img_html folder. The file name should match the name of the image, as described in step 1.
3. Insert the image into the new file, modify the title, as appropriate, and save the file.

The title usually matches the term in the glossary. You may add a subtitle or other explanatory text that you consider useful.

4. Insert the image hyperlink icon(.../system/images/eye.gif) in the glossary and aim the hyperlink at the new html picture file. 

The eye icon should be placed after the term, preceded by one space.

Add an Index Entry

Introduction
The index is the list of terms on the left side of the glossary. Index files are stored in folder .../system/html/. There are separate files for each letter of the alphabet, except for U-Z. Terms starting with U-Z are stored in a single file. The index files are named "toc_*.htm", where * represents the first letter of the terms the file indexes. 

   To create a table of contents entry

1. Open file .../system/html/toc_*.htm, where "*" is the first letter of your term.

Terms that start with numbers are stored in "toc_0.htm."

2. Create a new table row for your term. 
3. Copy/paste an existing term into the new cell and change it to the desired name. 

Term names in the table of contents should match term names in the glossary. However, if your term has an abbreviation or other parenthetical information after the term, do not include that information in the index. Include only the term itself.
4. Modify the hyperlink to point to the target file and bookmark.

Be sure the hyperlink opens the file in the correct frame (main).

Be sure to add any alternate terms or acronyms to the table of contents.