# HG changeset patch
# User Oleksandr Gavenko <gavenkoa@gmail.com>
# Date 1457887282 -7200
# Node ID ca5a7d9e7a4b7185ff741acf5db369f0858f6751
# Parent  904e71e64fbc6ccdf77e8dfbd138e78b68c59eda
Reason for switching to another dictionary source format.

diff -r 904e71e64fbc -r ca5a7d9e7a4b www/HACKING.rst
--- a/www/HACKING.rst	Sun Mar 13 18:32:19 2016 +0200
+++ b/www/HACKING.rst	Sun Mar 13 18:41:22 2016 +0200
@@ -37,8 +37,8 @@
   https://sourceforge.net/p/gadict/code/
     Sourceforge Allure interface (not primary, a mirror).
 
-Dictionary source file format
-=============================
+C5 dictionary source file format
+================================
 
 For source file format used dictd C5 file format. See::
 
@@ -48,23 +48,18 @@
 
  * Headwords was preceded by 5 or more underscore characters ``_`` and a blank
    line.
- * All text until the next headword is considered the definition.
+ * Article may have several headwords, in that case they are placed in one line
+   and separated by ``;<SPACE>``.
+ * All text until the next headword is considered as the definition.
  * Any leading ``@`` characters are stripped out, but the file is otherwise
    unchanged.
+ * UTF-8 encoding is supported at least by Goldendict.
 
-For convenience also used such assumptions:
+gadict project used C5 format in the past but switched to own format due to:
 
- * Headwords was separated by ``;<SPACE>`` (and all was placed on single line).
- * UTF-8 encoding was used.
- * Lines started with ``#`` striped out (comment syntax).
- * First line with ``ABOUT:`` used as description of dictionary.
- * First URL (line with ``http://``) used as dictionary home page.
-
-Comment syntax convention
-=========================
-
-As 'dictd -c5' format does not support comment syntax we filter out all
-lines that start with '#'.
+ * C5 is not structural format. So producing another forms and conversion to
+   other formats is not possible.
+ * C5 have no markup for links neither for any other markups.
 
 TODO convention
 ===============