AbsoluteWord Dictionary Maker manual

Introduction
Installation
Interface
Creating your own dictionary from scratch
Converting existing dictionaries to RoadLingua format
License agreement and copyright notice

Introduction

AW Dictionary Maker is a software for creating dictionaries compatible with AbsoluteWord RoadLingua - the popular dictionary viewer for PalmOS and PocketPC powered handhelds.
Basically, it was designed to convert CSV (comma-separated) files to RoadLingua format. Many third-party software products (such as Microsoft Excel) can export data to comma-separated format. You can also create your own dictionary from scratch using built-in editor. However, it is recommended to prepare dictionary files in other programs such as MS Excel, then export your data to a CSV file and convert it to RoadLingua format with AW Dictionary Maker.

AW Dictionary Maker has two versions: AWMaker.exe - main version with graphical user interface (GUI version) and awmakerc.exe (command-line version).

GUI version is suitable for most users.

Advanced users can try the command-line version. It does not have any graphical user interface and runs from the Windows command line (also known as Command prompt or DOS box). Command-line version of AW Dictionary Maker is also capable of processing tab-separated files. To see the full list of command-line version options and parameters, run

awmakerc.exe --help | more

Installation

AW Dictionary Maker does not require installation. Just create a folder on your hard disk drive (e.g. "C:\AWMaker") and copy all unzipped files from the distribution ZIP archive to that folder. Then run AWMaker.exe. You can also create a shortcut to AWMaker.exe on your desktop.

Interface

AW Dictionary Maker window contatins several controls (see the text below for detailed descriptions):

Interface

Window Menu

File menu item contains basic commands such as New, Open,Save as, Exit.

New allows you to start a new dictionary. Warning: all unsaved data will be lost!
Open allows you to open comma-separated files in AW Dictionary Maker
Save as command saves the current dictionary. You can choose to save it as CSV file (suitable for further editing) or PDB file (RoadLingua dictionary ready to be installed to your handheld)

Edit menu contains the following commands:

Add rows. Adds new empty rows to the end of the dictionary editor window.
Insert row inserts an empty row to the dictionary edit window. The new row is inserted before the selected row.
Delete row deletes a selected row from the dictionary edit window

Help menu provides access to AW Dictionary Maker manual and program info.

Dictionary Editor window

Dictionary editor window contains two columns: Word and Description/Translation. Each row represents a single dictionary entry. Use the Word column to enter the word itself, and the Descriptioin/Trasnlation column to enter the translation/description of the word. You do not need to keep any particular order of your words; AW Dictionary Maker will automatically re-sort all dictionary entries in the resulting RoadLingua dictionary. Duplicate entries are supported, too.

Use a special \n sequence to create a line-break in the description. See Creating your own dictionary from scratch for more info.

Please avoid descriptions containing more than 7000 symbols. Although AW Maker can work with such descriptions, in the resulting dictionary they will be splitted into several parts.

Use the "Edit" item of the main menu to add/insert/delete row(s).

Options

Here you can adjust dictionary settings:

ID is a special indentificator used by RoadLingua viewer to identify the dictionary. Must be 6 or less characters long. You can use Latin letters A...Z or a...z and digits 0...9 as a part of that ID. Other characters are not allowed.

Examples:

Correct IDs	Incorrect IDs
EngFre Dict12 abcRef	Dictionary (longer than 6 chars) Dict!! (contains "!' sign) Словарь (longer than 6 chars and contains non-Latin characters)

Please choose the unique ID for each of your dictionaries.

Title

Enter the title of your dictionary into this field

Unicode characters

Check this option if your dictionary uses Unicode characters (such as Chinese, Japanese etc.).

Large font

By default, translations appear in RoadLingua in small font. Check this option to set large font for translations/descriptions.

Source Language

Choose the source language of your dictionary. For example, German is the source language for German-English dictionary. This option helps AW Dictionary Maker determine the sort order for non-English entries. If you do not set this option, your dictionary will not work correctly.

Debug mode

If this option is checked, AW Dictionary Maker will not delete its temporary files. Most users do not need to check this option. But if you experience problems using AW Dictionary Maker, our support personnel may ask you to send us those tempopary files to find out the source of the problem.

Commercial

Check this option to create a commercial dictionary. Specify the number of trial days. When the trial period is over, the dictionary will expire.
To create a freeware dictionary, uncheck this option.

Abbreviations

You can provide a list of dictionary abbreviations. Abbreviations are not required.

Description

Enter dictionary description here. This text will appear under "About / Lexicon" menu item of RoadLingua viewer, so you can add copyright notice, author's name etc.
Description is not required

Buttons

The bottom part of AW Dictionary Maker window contains three buttons:

Save as CSV

Saves the current dictionary as a CSV (comma-delimited) file. You'll be prompted for a file name.

CSV files are useful to exchange data between applications. Use this format to save the uncompleted dictionary for further modifications -you'll be able to load it later using "File / Open" command of AW Dictionary Maker menu.

Save as PDB

Save the current dictionary as PDB file (RoadLingua dictionary format). Use this button to save your dictionary as a RoadLingua dictionary

PDB files are Palm database files which can be installed on Palm OS powered devices. RoadLingua uses the same format for PalmOS and Pocket PC dictionaries. To install the PDB dictionary on Pocket PC with RoadLingua, copy the dictionary PDB file to the RoadLingua installation directory (usually

"Program
files\RoadLingua"

). RoadLingua will detect it automatically.

Exit

Exit AW Dictionary Maker without saving changes

Creating your own dictionary from scratch

Start AW Dictionary Maker. You'll see the dictionary editor containing 2 columns: Word and Description/Translation. Now you can input words and their descriptions, as shown in the picture below:

Use "Edit -> Add rows" menu item to add new rows. If you need to insert a new (empty) row between already existing ones, use "Edit -> Insert row" menu item.

To delete a row, use "Edit -> Delete row" menu item.

A special \n sequence is used to add a line-break to the description / translation.

Example:

The description of My favourite word will appear in RoadLingua as follows:

Line breaks in RoadLingua for PalmOS

To save the dictionary for further editing, click "Save as CSV" button at the bottom of AW Dictionary Maker window, or choose "File -> Save as" menu item and save the dictionary as a CSV file. You can use the "File -> Open" menu item to open the previously saved dictionary in CSV format.

Once your dictionary is complete, click "Save as PDB" button at the bottom of AW Dictionary Maker window to convert your dictionary to RoadLingua format. Make sure that all necessary dictionary information (dictionary ID, title, source language) is entered (see Options for more info).

Converting existing dictionaries to RoadLingua format

If you have your dictionary database ready, you can convert it to RoadLingua format using AW Dictionary Maker.

First you need to export your dictionary database to a comma-separated format. Many applications (including Microsoft Excel) are capable of exporting your data to CSV format.

Below you'll find an example of data in comma-separated format (it is a fragment of English-Portuguese Common Phrases Dictionary):
Dictionary entries are marked with green. Translations are marked with purple.

I'm
concerned,Estou preocupado (interessado)

       I'm upset,Estou
preocupado (chateado)

       I'm worried,Estou
preocupado (ansioso)

Dictionary entries with comma(s) inside must be double-qouted:

Finicky,"Mimado, fresco"

       Trademark,"Marca
registrada, marca comercial"

"I usually walk to school, but sometimes my
father drives me","Normalmente vou para a
escola a pщ, mas algumas vezes meu pai me leva"

If an entry contains double quotes inside, they must be duplicated:

Word1,"Description contains ""quoted"" text"

Use \n symbol to insert a line-break to the definition:

Word1,"Description 1\nDescription 2"

When your CSV dictionary file is ready, start AW Maker and choose "File -> Open" menu item. The file will load into the AW Dictionary Maker dictionary editor. Set proper dictioinary settings in the Options section, then use "Save as PDB" button to create a RoadLingua-compatible dictionary.

License Agreement

AW Dictionary Maker
© 2002-2003 AbsoluteWord.com
All rights reserved

LICENSE AGREEMENT AND WARRANTY DISCLAIMER

CAREFULLY READ ALL OF THE TERMS AND CONDITIONS OF THIS AGREEMENT BEFORE USING THE PRODUCT.
BY INSTALLING THE PRODUCT ON YOUR COMPUTER YOU INDICATE YOUR COMPLETE AND UNCONDITIONAL ACCEPTANCE OF THESE TERMS AND CONDITIONS.

This documentation is a legal agreement between you (end-user of the Product) and the manufacturer/developer of the Product ("Vendor") concerning their use. THIS AGREEMENT CONSTITUTES THE COMPLETE AGREEMENT BETWEEN YOU AND VENDOR.

AGREEMENT

0. DISTRIBUTION: You are granted the right to distribute this software, providing that the distribution package is not changed, and you distribute it for free (without any charge).

1. LICENSE: Vendor grants you a non-exclusive license to use the Product in the manner described in the materials accompanying it. Vendor retains title to and ownership of the software that it may contain and in the patents, copyrights, trade secrets and other proprietary interests therein. You may make copies of the software. You may not make alterations or modifications to the software, or attempt to discover the source code of the software. The software may not be sublicensed, rented, or leased. Both the license and your right to use the software terminate automatically if you violate any part of this agreement. You may not disassemble, decompile or otherwise reverse-engineer the Products or otherwise attempt to learn the inner workings, source code, structure, algorithms, or ideas underlying them.

2. LIMITED WARRANTY: If you discover physical defects in the media on which the software is distributed or in the accompanying materials, Vendor will replace the media or manuals for a period of ninety (90) days after purchase by you. You must return the disk or manual to Vendor within the warranty period, accompanied by proof of purchase.

THIS WARRANTY DOES NOT APPLY TO DEFECTS DUE DIRECTLY OR INDIRECTLY TO MISUSE, ABUSE, NEGLIGENCE, ACCIDENT, REPAIRS, OR ALTERATIONS MADE BY YOU OR ANOTHER PARTY.

VENDOR AND ITS DISTRIBUTORS DISCLAIM ALL IMPLIED WARRANTIES, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, PERFORMANCE AND FITNESS FOR A PARTICULAR PURPOSE. VENDOR AND ITS DISTRIBUTORS WILL NOT BE LIABLE FOR ANY BUG, ERROR, OMISSION, DEFECT, DEFICIENCY, OR NONCONFORMITY IN ANY PRODUCT. AS A RESULT, THE PRODUCT IS PROVIDED "AS IS," AND YOU ASSUME THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE.

3. LIMITATION OF LIABILITY.

VENDOR AND ITS DISTRIBUTORS SHALL IN NO EVENT BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONTINGENT, OR CONSEQUENTIAL DAMAGES RESULTING FROM ANY DEFECT IN THE PRODUCT OR ITS ACCOMPANYING MATERIALS, INCLUDING DAMAGES FROM LOSS OF DATA, DOWNTIME, GOODWILL, DAMAGE TO OR REPLACEMENT OF EQUIPMENT OR PROPERTY, AND ANY COSTS OF RECOVERING, REPROGRAMMING, OR REPRODUCING ANY PROGRAM OR DATA USED IN CONJUNCTION WITH THE PRODUCTS, EVEN IF ONE OR MORE OF THEM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. ANY WRITTEN OR ORAL INFORMATION OR ADVICE GIVEN BY OTHERS WILL IN NO WAY INCREASE THE SCOPE OF THIS WARRANTY. NOR MAY YOU RELY ON ANY SUCH WRITTEN OR ORAL COMMUNICATION.