diff --git a/README.md b/README.md index bac2de2..a654941 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,45 @@ # Farhang Dictionary Production System (DPS) -The purpose of this project is to typeset bilingual dictionaries. After typesetting, it provides options to export them to a specially crafted TeX file, which uses `farhang.cls` LaTeX class file for the layout of the TeX files. It also has a SQLite export feature to be used for writing dictionary apps. +The purpose of this project is to typeset bilingual dictionaries. After typesetting, it provides options to export them to a specially crafted TeX file, which +uses `farhang.cls` LaTeX class file for the layout of the TeX files which will then be converted to PDF using TeXLive distribution using XeLaTeX. It also has a +SQLite export feature to be used for writing dictionary apps. -It is written in C# and uses MongoDB as database for storing dictionary entries as separate documents. It has been developed about 6 years ago and is very old. I used Mercurial (Hg) to manage the project, but converted the whole project from Mercurial to Git, just before making it free using hg-git plugin, mercurial package, python and bitbucket. +It is written in C# and uses MongoDB as database for storing dictionary entries as separate documents. The first (stone-age) version was developed about 9 +years ago using Python, PostgreSQL and it was developed on Debian and was cross-compiled for windows. The current version has been developed about 6 +years ago and is very old and possibly needs refactoring and adding features. +I used Mercurial (Hg) to manage the project, but converted the whole project from Mercurial to Git, just before making it free using hg-git plugin, mercurial package, python and bitbucket. -In order to run the project, you should install MongoDB and compile and run the project from source. I will try to provide a binary version for your convenience if I can find a suitable time. +In order to run the project, you should install MongoDB and compile and run the project from source. I will try to provide a binary version for your convenience +if I can find a suitable time. Also, you should have `DejaVu` font family installed on your machine to be able to use this software, since this font family has +by far the most complete set of unicode characters. You can download it [here](https://dejavu-fonts.github.io/). It is published with Free License and is in +Public Domain. This project is used to typeset a bilingual German-Persian dictionary of over 2600 pages which is published by Zabankadeh and Langenscheidt AG. [Großwörterbuch Deutsch – Persisch](https://www.langenscheidt.com/deutsch-daf/schule-studium-woerterbuch/langenscheidt-grosswoerterbuch-deutsch-als-fremdsprache-hardcover) -## Screenshot -![Farhang 2 Screenshot](/assets/farhang.png) +## Screenshots -## TeX Output - +### Main screen +![Farhang 2 Screenshot - Main Screen](/assets/farhang.png) + +### International Phonetic Alphabet (IPA) Keyboard + + +### SQLite Database Exporter (a.k.a. Mobile Database Exporter) + + +### Manual Headword Sorter +![Farhang 2 Screenshot - Manual Headword Sortter](/assets/Manual-Headword-Sorter.png) + +### TeX Exporter (aka. PDF Builder) + + +### Generated TeX file + + +### TeX->PDF Output + ## Contribution Contribution is always welcome! To report bugs, simply open an issue and fill it with related information. To fix a bug, fork the repository, fix the bug, push to your own fork, make a pull request and done! diff --git a/assets/IPA-keyboard.png b/assets/IPA-keyboard.png new file mode 100644 index 0000000..18a697c Binary files /dev/null and b/assets/IPA-keyboard.png differ diff --git a/assets/Manual-Headword-Sorter.png b/assets/Manual-Headword-Sorter.png new file mode 100644 index 0000000..b4adc31 Binary files /dev/null and b/assets/Manual-Headword-Sorter.png differ diff --git a/assets/SQLite-exporter.png b/assets/SQLite-exporter.png new file mode 100644 index 0000000..aca1978 Binary files /dev/null and b/assets/SQLite-exporter.png differ diff --git a/assets/tex-exporter.png b/assets/tex-exporter.png new file mode 100644 index 0000000..1128eb5 Binary files /dev/null and b/assets/tex-exporter.png differ diff --git a/assets/tex-input.png b/assets/tex-input.png new file mode 100644 index 0000000..d4e84a2 Binary files /dev/null and b/assets/tex-input.png differ