Important changes note for the DictionaryForMIDs tools and applications

Changes brought to the tools behavior by DfM-Creator

In the previous versions of DictionaryGeneration, the generated dictionary files were put directly in the output directory provided by the user. At that time, the user was asked to make sure the output directory's name that she provided is dictionary. Now, DictionaryGeneration, both the GUI and the command line versions create a directory named dictionary before starting to generate the dictionary files. It is still required though, that the user provides an output directory because it is in it that the final output directory (dictionary) is created. For users who automatically set up their dictionaries through scripts, adapt your scripts accordingly.

Also note that now even JarCreator has a similar behaviour. In its older versions, JarCreator would write the created jar and jad files right in the output directory provided by the user, now, it writes them in a directory that it creates just before starting to generate the files. The name of the directory depends on the name of the final jar/jad files. Recall that JarCreator creates the name of the jar/jad files from the DictionaryForMIDs.properties file. If for instance the name of the jar/jad files would be DFM_EngDef_Wordnet.jar and DFM_EngDef_Wordnet.jad, then the name of the directory in which the above-mentioned jar/jad files will be writen to would also be DFM_EngDef_Wordnet but without the jar/jad extension.

As a final note, keep in mind that both DictionaryGeneration and JarCreator need to have the required permissions (i.e read/write permissions especially on UNIX/Linux) to be able to create these directories in the location that you provided otherwise and exception will be thrown stating that DictionaryGenerator or JarCreator failed to create the directory. And if the directories cannot be created, the dictionary-files/jar-jad-files will not be generated/written.

Changes brought by DictonaryGeneration-3.5.0

With DictonaryGeneration 3.5.0, the text between {{ and }} is ignored while building the indexs. See section Reducing the size of the generated index files. If this behavior is not desired, it can be turned off by seting the property dictionaryGenerationOmitParFromIndex to false. The class DictionaryUpdatePartialIndex is obsolete starting with 3.5.0 (still included for compatibility reasons, but without any function).

Changes brought by DictonaryGeneration-3.0.0

With DictionaryGeneration 3.0.0 the Normation classes are now located in the package de.kugihan.dictionaryformids.translation.normation.
DictionaryUpdate classes are now located in the package de.kugihan.dictionaryformids.dictgen.dictionaryupdate.
For existing DictionaryForMIDs.properties files, the properties NormationClassName and DictionaryUpdateClassName do not need to be updated, because DictionaryForMIDs automatically maps the old package names to the new package names.

Changes brought by DictonaryGeneration-2.7.0

With DictionaryGeneration 2.7.0 the 'pre-normate'-call which did remove punctuation characters was removed; normation now relies completely on the normation class. Starting with 2.7.0 the normation classes can use the method Util.removePunctuation to remove punctuation characters (with DictionaryGeneration < 2.7.0 this was done automatically); or just call NormationLib.defaultNormation as the first step in normation.

Changes brought by DictonaryGeneration and DictionaryForMIDs 2.5.0

With DictionaryForMIDs 2.5.0 / DictionaryGeneration 2.5.0: The structure of the index file was extended with the searchindicator (see Files generated by the DictionaryGeneration tool). For this reason the dictionaries have to be re-generated with DictionaryGeneration 2.5.0.
Also, with DictionaryGeneration 2.5.0 a change for the DictionaryUpdate class was introduced: the method removeDisturbingWords was renamed to the method updateKeyWordVector; now the keywords in the vector are accessed with:
((IndexKeyWordEntry) keyWordVector.elementAt(elementCount)).keyWord