How do I build a Babylon glossary?

Introduction

Babylon Glossary Builder
Babylon Glossary Builder is a user friendly application that simplifies the creation of glossaries. Babylon Glossary Builder made the process of building a glossary easy and simple: 
Data sources will be converted to a valid Babylon glossary.
Organizing your data in a glossary structure has never been as easy. 

Babylon Glossary Builder functions

 Design your own glossary

Babylon Glossary Builder allows you to design your glossary style. You may either have different designs in the same term or one style for the whole glossary. Designing a glossary is as simple as creating an HTML page using HTML code.

 Extract your Data source to Babylon glossary

Babylon Glossary Builder converts excel files to a simple, comfortable, and "clickable" Babylon glossary. After the "build" process is completed successfully, your glossary is ready to be installed on Babylon clients and function as a "Babylon glossary".
Babylon Glossary Builder enables you to enjoy your complicated, long, and ramified data source files to a much more useful, comfortable, and effective "one click" information source. 

 Creating Traffic to Your Site Using Hyperlinks 

Use the hyperlink feature in Babylon's Builder to link any word in the text of your definitions back to your site. This will create traffic to your site from Babylon's large community of users. 

Create even more traffic by making your glossary more attractive, adding an icon to the glossary title or pictures to the definitions (BMP, JPG, ICO). 

 Share your knowledge through the web 

Once you have built your glossary, you can upload it through the web and share it with others as well as maintain it in a very simple way. 
Babylon has a database of over 1,300 dictionaries, encyclopedias and glossaries in 50 languages, covering a wide range of fields. 
To see Babylon's glossaries go to: http://www.babylon-software.com/free-dictionaries 

  Minimum Requirements

Babylon Glossary builder works with the following:
Operating System: Windows 2000/XP/Vista (as of December 2006).
.net version 2 or above.
32 bit OS or 64 bit when running in 32 bit mode.
MS Office XP/2003/2007

Terminology

  Glossary (BGL) 

A compiled glossary file that can be deployed on the Babylon-Client. 

  Spelling alternatives 

When no results are delivered for a term, it might be due to a misspelling or a typographical error. Clicking the "Spellchecker" button at the bottom of the Results pane produces alternative results.

  GPR (Babylon Builder Project)

A Babylon Builder project Format. This format has been developed by Babylon and has become a Babylon glossary builder standard for updating/creating a Babylon glossary file.

  GLS

A legacy format that uses proprietary syntax. This is a text file that includes all the terms and definitions written in a special format identified by the Glossary Builder.

 UTF-8 

A variable-length character encoding for Unicode. It enables the representation of any universal character in the Unicode standard. Yet, the initial encoding of byte codes and character assignments for UTF-8 is concurrent with ASCII.

  Term 

Word or phrase that is defined in the glossary. The term is the primary key (Index) of the glossary

  Alternate 

Words that share the same definition as the term.

  Definition

Information about the selected term and its alternate forms.

Welcome Screen

Babylon Glossary Builder Welcome screen:

 Start a new glossary project

Select the "Start a new glossary project" to start building a new glossary project from scratch. The glossary will get a unique ID that will be saved for further use.

 Work on an existing glossary project 

Select the "Work on an existing glossary project" to update or continue working on an old project. In this option all the glossary terms, definitions, alternates, glossary ID and version will be retrieved and maintained in the newly created glossary. The glossary version will be incremented, which is to prevent a duplicate glossary.

 Quick build

This option is enabled while loading a valid glossary project. This option will lead directly to the build screen.

 Help

Online help is available for Babylon Glossaries Builder. This help is available at any stage.

General glossary properties

The purpose of this step is to define the glossary header details and glossary data file.

• Glossary name

Define the glossary name. For example: Employee. This is a mandatory field.

 Glossary Author name

You may enter the author name or the publisher name for this glossary, which is to be displayed in the "About" information of this glossary. The publisher name will be inherited from the computer name. For example: Paul.

 Glossary Author mail 

You may enter the glossary Author E-mail address in this field. For example: John@babylon-software.com.

 Source language 

Define the language of the terms (search keys). This information is used to find terms correctly when multilingual Glossaries are installed. For example: English. 

 Target language 

Define a language of the search results. For example: English. 

 Glossary description 

A short synopsis about the glossary. It will be displayed in the glossary "About" section and may include HTML content.

 Copyright message 

Enter a copyright message to be displayed at the end of each glossary entry in order to protect the author copy rights. It may include HTML content.

 Glossary icon 

The icon associated with the glossary. The icon is usually displayed together with the glossary's title (Babylon icon is default icon). Click "change" in order to load a different icon file. The file must have an ICO extension.

 Advanced

  Use utf-8 encoding 

By checking the UTF-8 box, you will enforce UTF-8 encoding. The default option for this entry is "False". When in "False", the default alphabet is determined according to the source and target alphabet.

  Browsing enabled 

Defines whether users can browse through the glossary entries

  Spelling alternatives

When enabled, Babylon will search for spelling alternatives in this glossary (following spelling alternatives conditions). Otherwise, spelling alternatives for the glossary will be disabled.

  Case sensitive search 

Disabling this option (uncheck) overrides the glossary's Case sensitivity property. Enable this option (checked) mark the search in this glossary as Case sensitive. 

  Enable substring search

Substring search retrieves results when searching a substring of the search key (AKA term). The substring must complete at least one word within the term in order to retrieve results.
Please note: Using this option increases the search complexity significantly. As a result, machine performance might be affected at the time of search.

 Substring search length

Set the substring length, values range is: 1-100 (0 disables this feature).

  Glossary manual file 

Babylon Builder enables you the option to attach a manual file to your glossary. The file will be available from the "Glossary details" screen in Babylon client.

Data source definitions

 Data sources 

Select the Data source from which you glossary entries will be extracted. After choosing the data source, the relevant configuration appears. 

 Excel Worksheet data source

 Excel file

Define the Excel file. Once defined, the worksheets will be loaded. 

 Worksheet 

Choose the sheet in the Excel file you wish to convert. 

Data Source- Table data definition (relevant for excel data source only)

 Use first row as the column name

This option determines if the rest of the table definitions will treat the first row in the Excel worksheet as the column names. When unchecked, Babylon builder will treat the built in column enumeration (A, B, C ...). 
 Term column 

Choose the column in the Excel file that includes the required terms. Default term is the left upper column in the Excel file. Example: A
 Split term column into alternate terms using the following delimiters

This option enables creation of alternate terms from the initial term by splitting it according to the defined delimiters.
 Alternate columns 

Choose columns to represent the alternate words for term. Clicking "add" open the following window to select columns as alternative terms. (Multi selection using "ctrl") 

 Definition columns 

Choose column to represent the definition for each term. Multiple selections are available with Ctrl.
 Advanced Styling

The advanced and simple styling option allows the user to modify the glossary results styling using HTML tags, either in parts of the document or in its entirety. The styling affects the glossary only, and not on Babylon's client style.

 Use simple Templates

Those are general and fixed settings, which apply to the whole project. The settings here are the most common settings, and simple to control.
  New line between definitions columns

The line spacing between multiple definitions for a term will be set to 1 line. This style will apply to the whole project. (Enabled by default)
  Show column name in definition 

Select this option to display the column name along with the definition display. This style will apply to the whole project. (Enabled by default)
  Use HTML values 

The project treats the text as HTML tags. This will mark any tag or value as HTML and will be considered as such. For example: one of the columns contains the text: 1<5. Upon enabling the: "Use HTML values," The Babylon Glossary Builder will treat it as an HTML tag. Since 1<5 is not a valid tag, the result is an empty definition.

 Use the following HTML template 

This option allows you to design the results layout in your glossary using HTML tags. 
To specify definition column from the Excel worksheet, use the following special tag:

Field name: The column name as defined in the Excel worksheet.
Format: The options can be either "text" or "HTML". This allows you to define one column values as HTML and another as text.

Example:
The following HTML will order the definition columns in the glossary in a table:

And the result will be:

 Special cell values

• Hyperlinks 
  
  - Hyperlink to a local file which is embedded in the glossary. The file is opened as a result of a click on the Hyperlink.
  - Hyperlink to a web-page (http ://) opens the web-page in an external browser.
  - Hyperlink to a different sheet in the Excel is ignored.
  - Hyperlink to an email address runs the Mailto: action just as the Excel does.
    Formulas 
  
  When extracting formulas, the actual formula's result is extracted (in compilation time). 
  
   GLS data source
  
  Select the GLS file and continue to build screen.
  
  

  Preview

  
  Preview will allow you to simulate how your glossary will look like. The Preview will display the first term and definition of the proposed glossary. (In order to use the preview option, Babylon client should be installed).
  

  Build

  
  
   Output glossary file 
  
  Defines the destination folder for saving the glossary file. This file will save the final Glossary file for Babylon use. 
   Save glossary project 
  
  Defines the destination folder for saving the glossary project. The glossary project files are saved for further maintenance of the glossary.
   Build 
  
  Use this command to build the glossary.
  
  

  Test glossary in Babylon client

  
  Translate a term and check the glossary appearance. For example: "Mr.Blue"
  
  

  Command-line interface

  
  There is an option to convert GLS file to GPR using command line. To allow this option use:
   /Build
  
  "/Build" enables the option to build a glossary using the glossary profile GPR via the command line(and save an updated version number to it). 
  Babylon retail builder.exe –build 
   /GPRFromGLS
  
  "/GPRFormGLS" enables the option to generating a project file (GPR) from a GLS file that includes header or from header GLS and data GLS.
  /GLStoGPR GLS GPR 
  This option is if the GLS includes header or form header in addition to the date GLS.
  /GLStoGPR GLSHeader GLSData GPR 
  
   

  Submitting your glossary?

  
  
  After creating your glossary, you can easily publish your content in your organization or even in Babylon's glossary index, where it will be available to other users for download.
  To publish your glossary within Babylon's site, you must register first as a Babylon Author. To register as an author, simply fill in your details and Babylon will send you an email containing an account activation link. 
  To register as an author in Babylon click here:
  http://authors.babylon-software.com/register.php
  
  If you are already a member of Babylon authors click here to sign in:
  http://authors.babylon-software.com/
  
  In the following step you'll have to upload your BGL file, and your new glossary will be reviewed by our linguistic team and when approved, will be published on Babylon community. 
  
  

  Appendix A

  
   GLS Files 
  
  The GLS glossary source file contains the terms (glossary) and their definitions comprising the glossary. 
  The main body of the glossary source text file consists of a collection of entries called terms.
  These are the words and phrases defined in the glossary. The term is the primary key (index) of the glossary.
  
  Glossary Terms Section contains the elements that comprise the data of the glossary. Each term element contains a word or a phrase (the glossary term) and a definition. It may also include alternate forms and other elements that control the term's behavior and graphical display.
   GLS Terms Syntax
  
  In the GLS file, each term or glossary entry has the following basic structure:
  
  [blank line]
  Term | Alternate1 | Alternate2| ... | AlternateK
  [attributes]
  Definition
  [blank line]
  
    Text Formatting
  
  Definitions may contain HTML tags to enhance their formatting and display in Babylon-client.
  In addition to standard HTML tags, the following tags can also be used in the glossary source Files:
  Alternate Name
  
  
   How to generate an updated glossary from an old GLS?
  
  Babylon Glossary Builder will open GLS files as data sources. The GLS file will transform them into GPR files. The GPR file include a reference to the GLS file, and will keep the GLS glossary ID, to prevent duplicate glossaries. 
  
   Start a new glossary project.
• Fill all the glossary properties in the General glossary properties as described in section 3.
• Upload your GLS file and build the glossary, save your glossary project for further use.
• This will create GPR and BGL file from your GLS file. This glossary file will contain all the GLS terms, alternates and definitions, and the same glossary ID.
  
  
  If you wish to edit the GLS file terms, please refer to Syntax GLS section.
• Source: https://support.babylon.com