# HG changeset patch # User Oleksandr Gavenko # Date 1457886392 -7200 # Node ID e3d85aeefdec297ce25fb1031971ae4a8df4cf1a # Parent 9c952f287a8b7173568ea9d485bfac7f5dd1ab0e Remove trailing dot from section titles. diff -r 9c952f287a8b -r e3d85aeefdec www/HACKING.rst --- a/www/HACKING.rst Sun Mar 13 18:22:46 2016 +0200 +++ b/www/HACKING.rst Sun Mar 13 18:26:32 2016 +0200 @@ -1,20 +1,20 @@ .. -*- coding: utf-8 -*- -======================= - gadict HACKING guide. -======================= +====================== + gadict HACKING guide +====================== .. contents:: :local: -Versioning rules. -================= +Versioning rules +================ We use **major.minor** schema. Until we reach 5000 words **major** is 0. **minor** updated from time to time. -Getting sources (VCS). -====================== +Getting sources +=============== Cloning repository:: @@ -27,8 +27,8 @@ $ hg push ssh://$USER@hg.code.sf.net/p/gadict/code $ hg push https://$USER:$PASS@hg.code.sf.net/p/gadict/code -Browsing sources. -================= +Browsing sources online +======================= http://hg.defun.work/gadict hgweb at home page. @@ -37,8 +37,8 @@ https://sourceforge.net/p/gadict/code/ Sourceforge Allure interface (not primary, a mirror). -Dictionary source file format. -============================== +Dictionary source file format +============================= For source file format used dictd C5 file format. See:: @@ -60,28 +60,28 @@ * First line with ``ABOUT:`` used as description of dictionary. * First URL (line with ``http://``) used as dictionary home page. -Comment syntax convention. -========================== +Comment syntax convention +========================= As 'dictd -c5' format does not support comment syntax we filter out all lines that start with '#'. -TODO convention. -================ +TODO convention +=============== Entries or parts of text that was not completed marked by keywords: TODO - incomplete + incomplete XXX - urgent incomplete + urgent incomplete Makefile rules ``todo`` find this occurrence in sources:: $ make todo -Dictionary file name convention. -================================ +Dictionary file name convention +=============================== BNF form:: @@ -92,8 +92,8 @@ where ``ISOCODE`` is ISO 639-1 language (2 letter) code, currently ``en``, ``ru``, ``uk`` in use, ``NAME`` is dictionary abbreviated name. -World wide dictionary formats and standards. -============================================ +World wide dictionary formats and standards +=========================================== http://en.wikipedia.org/wiki/Dictionary_writing_system Dictionary writing system @@ -117,8 +117,8 @@ http://deb.fi.muni.cz/index.php DEBII — Dictionary Editor and Browser -Register gadict dictionaries for dictd under Debian. -==================================================== +Register gadict dictionaries for dictd under Debian +=================================================== :: $ su @@ -131,8 +131,8 @@ $ dictdconfig --list $ dict -d gadict-dictabbr v -Typing IPA chars in Emacs. -========================== +Typing IPA chars in Emacs +========================= For entering IPA chars use IPA input method. To enable it type::