Import formats

Introduction

This document presents the structure of the export and import files of Antidote’s personal dictionaries.

Structure of the Export and Import Files

• Text format
• Each line must contain 1, 2 or 8 tokens separated by tabulations
• Lines beginning with “//” are ignored with some exceptions (see the sections Word Language and Encoding)
• Empty lines are ignored.

Word Language

• To specify the language of the words to import, the following three identifiers are used :
  • FR: French
  • EN: English
  • ML: Multilingual (English and French)

• These identifiers can be used in two places:

  • Globally, indicating the identifier in parentheses at the beginning of the file in the following comment:

    Name : DICTIONARY_NAME (LANGUAGE_IDENTIFIER)

  • For each word, indicating the language identifier as the first attribute (see the section Importing 8 tokens below)

  • If the language is unspecified according to the previous methods:

    • In multilingual Antidote, an import error will occur.
    • In monolingual Antidote, the default language will be that of Antidote.

Encoding

Antidote tries to guess the file’s encoding based on the content and your system platform. You can also tell Antidote which encoding you are using without it having to guess: Use the special comment coding: at the beginning of the file followed by the encoding identifier.

Here are the encoding identifiers :

• mac_roman
• iso8859_15
• cp1252
• utf_8
• utf_16_le
• utf_16_be

Example :

// coding: utf_8

Importing One Token

If a line only contains one token, that token is considered the base form and Antidote infers the word category, and (if required by the category) word morphology or verb model. In multilingual Antidote, the word language must be globally specified at the top of the file with a special comment (see the section Word Language)

BASE_FORM __END_OF_LINE__

Importing Two Tokens

If a line contains two tokens, the first token is considered the base form and the second is considered the category. Antidote infers the word morphology or verb model, if required by the category.

In multilingual Antidote, the word language must be globally specified at the top of the file with a special comment (see the section Word Language)

BASE_FORM __TAB__ CATEGORY __END_OF_LINE__

Importing 8 tokens

If a line contains 8 tokens, these tokens are considered in the following order:

• Base form
• Category
• Inflection 1 field
• Inflection 2 field
• Inflection 2 field
• Inflection 2 field
• Attributes separated by +

• Definition

  • To introduce a new definition, insert the “◊” character
  • To introduce a new paragraph, insert the “” and “r” characters

  • For a multilingual word, it is possible to specify a definition for each language. All definitions are specified in the same field. The French definition must be preceded by the keyword |FR| and the English definition by the keyword |EN|.

    Example:

    |FR|Définition de « ABCDEFG »|EN|Definition of “ABCDEFG”

Accepted Categories

French Words

• Acronyme (acronym or initialism)
• Adj (adjective)
• Adv (adverb)
• Interj (interjection)
• LocutionLatine (Latin expression)
• Nom (common noun)
• NP (proper noun)
• Verbe (verb)
• Pref (préfix)

English Words

• Acronym (acronym or initialism)
• Adj (adjective)
• Adv (adverb)
• Interj (interjection)
• Noun (common noun)
• PN (proper noun)
• Verb (verb)

Multilingual Words

• Acronyme (acronym or initialism)
• Acronym (acronym or initialism)
• NP (proper noun)
• PN (proper noun)

Inflection Fields

French Words

• Acronym, adjective, adjectival Latin expression, noun, proper noun
  • Inflection 1 field: Masculine singular
  • Inflection 2 field: Masculine plural
  • Inflection 3 field: Feminine singular
  • Inflection 4 field: Feminine plural
• Verb
  • Inflection 1 field: Verb model
  • Inflection 2 field: Leave empty
  • Inflection 3 field: Leave empty
  • Inflection 4 field: Leave empty
• Adverb, adverbial Latin expression, interjection, prefix
  • Inflection 1 field: Leave empty
  • Inflection 2 field: Leave empty
  • Inflection 3 field: Leave empty
  • Inflection 4 field: Leave empty

English Words

• Noun, acronym
  • Inflection 1 field : Singular
  • Inflection 2 field : Plural
  • Inflection 3 field : Leave empty
  • Inflection 4 field : Leave empty
• Adjective
  • Champ de flexion 1 : Singulier
  • Champ de flexion 2 : Comparatif
  • Champ de flexion 3 : Superlatif
  • Champ de flexion 4 : À laisser vide
• Verb
  • Inflection 1 field: 3rd person
  • Inflection 2 field: Past
  • Inflection 3 field: Past participle
  • Inflection 4 field: Present participle
• Adverb, interjection, proper noun
  • Inflection 1 field: Leave empty
  • Inflection 2 field: Leave empty
  • Inflection 3 field: Leave empty
  • Inflection 4 field: Leave empty

Multilingual Words

• Acronym, proper noun
  • Inflection 1 field: Masculine singular
  • Inflection 2 field: Masculine plural
  • Inflection 3 field: Feminine singular
  • Inflection 4 field: Feminine plural

Attributes Accepted for Each Category

French Words

• Noun
  • Chose
    • Entite
    • Diplome
  • Personne
    • Fonction
  • Animal
• Adjective
  • Habitant
    • Langue
• Interjection
  • Sensation
  • Message
  • Bruit
• Adverb
  • Maniere
  • Temps
  • Lieu
• Locution latine
  • Adjectif
  • Adverbe
• Proper Noun
  • Famille
  • Prenom
  • Compagnie
  • Marque
  • Lieu
    • VoieDeCirculation
    • Ville
    • Ile
    • Region
    • CoursDeau
    • CorpsCeleste
  • Habitant
    • Langue
  • TitreOeuvre
  • Autre
• Acronym
  • Compagnie
  • Chose
    • NonComptable
    • Diplome
  • Personne
    • FonctionSociale
• Verb
  • No attribute is accepted
  • Accepted models
    • Aimer
    • Finir
    • Courir
    • Rendre
• Prefix
  • FacultTDU
  • BesoinTDU
  • ErreurTDU
  • FacultTDUReforme
  • BesoinTDUReforme
  • ErreurTDUReforme

English Words

• Noun
  • Thing
    • Entity
    • Diploma
  • Person
    • Profession
  • Animal
  • Group
• Adjective
  • Demonym
    • Language
• Interjection
  • Emotional
  • Message
  • Sound
• Adverb
  • Manner
  • Time
  • Place
• Proper Noun
  • LastName
  • FirstName
  • Company
  • Brand
  • Place
    • Street
    • Town
    • Island
    • Region
    • CourseOfWater
    • CelestialBody
  • Demonym
    • Language
  • TitleOfAWork
  • Other
• Acronym
  • Company
  • Thing
    • Uncountable
    • Diploma
  • Person
    • Profession
• Verb
  • No attribute is accepted

Multilingual Words

• Proper Noun
  • Famille, LastName
  • Prenom, FirstName
  • Compagnie, Company
  • Marque, Brand
  • Lieu, Place
    • VoieDeCirculation, Street
    • Ville, Town
    • Ile, Island
    • Region, Region
    • CorpsCeleste, CelestialBody
  • Habitant, Demonym
    • Langue, Language
  • TitreOeuvre, TitleOfAWork
  • Autre, Other
• Acronym
  • Compagnie, Company
  • Chose, Thing
    • NonComptable, Uncountable
    • Diplome, Diploma
  • Personne, Person
    • FonctionSociale, Profession