www/HACKING.rst
changeset 347 05df277da404
parent 346 738da7eddaca
child 348 f089cd68ea7b
equal deleted inserted replaced
346:738da7eddaca 347:05df277da404
    35   http://hg.code.sf.net/p/gadict/code
    35   http://hg.code.sf.net/p/gadict/code
    36     hgweb at old home page (but supported as mirror).
    36     hgweb at old home page (but supported as mirror).
    37   https://sourceforge.net/p/gadict/code/
    37   https://sourceforge.net/p/gadict/code/
    38     Sourceforge Allure interface (not primary, a mirror).
    38     Sourceforge Allure interface (not primary, a mirror).
    39 
    39 
       
    40 Dictionary file name convention
       
    41 ===============================
       
    42 
       
    43 BNF form::
       
    44 
       
    45   FILE ::= "gadict_" NAME ".gadict"
       
    46 
       
    47 ``NAME`` may have form ``ISOCODE "-" ISOCODE``, like ``en-ru``, where
       
    48 ``ISOCODE`` is ISO 639-1 language (2 letter) code
       
    49 
       
    50 ``NAME`` may be a dictionary abbreviation name.
       
    51 
       
    52 During dictionaries compilation and releases ``".gadict"`` suffix changed to
       
    53 appropriated but base name should be preserved as ``"gadict_" NAME``.
       
    54 
    40 C5 dictionary source file format
    55 C5 dictionary source file format
    41 ================================
    56 ================================
    42 
    57 
    43 For source file format used dictd C5 file format. See::
    58 For source file format used dictd C5 file format. See::
    44 
    59 
    58 gadict project used C5 format in the past but switched to own format due to:
    73 gadict project used C5 format in the past but switched to own format due to:
    59 
    74 
    60  * C5 is not structural format. So producing another forms and conversion to
    75  * C5 is not structural format. So producing another forms and conversion to
    61    other formats is not possible.
    76    other formats is not possible.
    62  * C5 have no markup for links neither for any other markups.
    77  * C5 have no markup for links neither for any other markups.
    63 
       
    64 Dictionary file name convention
       
    65 ===============================
       
    66 
       
    67 BNF form::
       
    68 
       
    69   FILE ::= "gadict_" NAME ".gadict"
       
    70 
       
    71 ``NAME`` may have form ``ISOCODE "-" ISOCODE``, like ``en-ru``, where
       
    72 ``ISOCODE`` is ISO 639-1 language (2 letter) code
       
    73 
       
    74 ``NAME`` may be a dictionary abbreviation name.
       
    75 
       
    76 During dictionaries compilation and releases ``".gadict"`` suffix changed to
       
    77 appropriated but base name should be preserved as ``"gadict_" NAME``.
       
    78 
    78 
    79 TODO convention
    79 TODO convention
    80 ===============
    80 ===============
    81 
    81 
    82 Entries or parts of text that was not completed marked by keywords:
    82 Entries or parts of text that was not completed marked by keywords: