README.rst

   1 =================================
   2 Internation Word Database Project
   3 =================================
   4
   5 This site is a user generated database of all the words in all languages.
   6 Each word has meanings, usage, synonyms, thesaurus etc information about it.
   7 This project basically captures all the information present in wiktionary_,
   8 thesaurus_, `mariam webster`_ and answers.com_.
   9
  10 Its a structured wiki.
  11
  12 Note
  13 ----
  14
  15 This is RestructuredText_ document, and it can be viewed by using package
  16 restview_ (Command to use: "``$ restview .``").
  17
  18 Code Guideline
  19 --------------
  20
  21 #. Try to limit line width to 78 chars.
  22 #. Use 4 spaces instead of tabs for indentation.
  23
  24 Project Setup Notes
  25 -------------------
  26 * all(ideally) database changes should be done through dmigration_. run
  27   ``./manage.py dmigrate all``.
  28 * :raw-html:`<s>create super user: ./manage.py createsuperuser</s>` done
  29   through migration now
  30 * :raw-html:`<s>create a site by going to site admin page</s>` done through
  31   migration now
  32 * **do not** run ``./manage.py syncdb``.
  33 * create ``local_settings.py`` to avoid accidentally committing into
  34   settings.py and in general to easy debug/development.
  35 * put gmail account details in ``local_settings.py`` get mails working.
  36
  37 ToDo
  38 ----
  39
  40 Basic website
  41     * :raw-html:`<s>registration/login/logout</s>`
  42     * basic website look
  43     * :raw-html:`<s>finalize worddb.words.models.*</s>`
  44     * help/aboutus/faq pages
  45     * :raw-html:`<s>add admin things for all models in worddb.words.models</s>`
  46     * i18n
  47
  48 tasks:
  49     * :raw-html:`<s>language contraints</s>`
  50         * :raw-html:`<s>put language contraints for antonyms/synonyms
  51           etc.</s>`
  52         * :raw-html:`<s>translation can not be in same language, but more
  53           than one translation in same language shud be allowed.</s>`
  54     * :raw-html:`<s>multi word, remove wordform etc</s>`
  55         * :raw-html:`<s>remove word form and add forms column in
  56           word table</s>`
  57         * :raw-html:`<s>remove fk to form from pronounciation and add
  58           spelling column there</s>`
  59     * :raw-html:`<s>remove usage table</s>`
  60     * :raw-html:`<s>add not_a_word to word</s>`
  61     * :raw-html:`<s>add is_deleted/deleted_on to pronounciation/meaning</s>`
  62     * :raw-html:`<s>add related words m2m</s>`
  63     * script/unicode detection for language and contraints on it
  64
  65 worddb.words.views
  66     * main word page: normal page [will handle new word creation too]
  67     * :raw-html:`<s>add/remove meaing: ajax</s>`
  68     * :raw-html:`<s>edit meaning meaning/usage/pol: ajax</s>`
  69     * :raw-html:`<s>add/remove synonym: ajax</s>`
  70     * :raw-html:`<s>add/remove form: ajax</s>`
  71     * :raw-html:`<s>change language: ajax</s>`
  72     * :raw-html:`<s>update etymology: ajax</s>`
  73     * :raw-html:`<s>add/remove thesaurus: ajax</s>`
  74     * :raw-html:`<s>add/remove antonym: ajax</s>`
  75     * :raw-html:`<s>add/remove translation: ajax</s>`
  76     * :raw-html:`<s>add/remove rhyme: ajax</s>`
  77     * :raw-html:`<s>add/remove/edit pronounciation: ajax</s>`
  78
  79 changesheet related views
  80     * show changes for this word
  81
  82 ajax
  83     * add meaing: ajax
  84     * edit meaning meaning/usage/pol: ajax
  85     * remove meaning: ajax
  86     * add synonym: ajax
  87     * remove synonym: ajax
  88     * add form: ajax
  89     * remove form: ajax
  90     * change language: ajax
  91     * update etymology: ajax
  92     * add/remove thesaurus: ajax
  93     * add/remove antonym: ajax
  94     * add/remove translation: ajax
  95     * add/remove rhyme: ajax
  96     * add/remove/edit pronounciation
  97
  98 utilities etc
  99     * ajax form handler generic view
 100
 101 Later/Maybe
 102     * reorder synonyms/antonyms/... etc
 103     * show changes by user
 104     * show changes by language
 105     * show sitewide latest changes
 106     * rss/feed for all of them
 107     * "talk page" for words ala wikipedia
 108     * edit message along with all changes by user
 109     * autocomplete word change form on all word pages
 110     * autocomplete in suggestion for add-* forms
 111
 112
 113 Worklog
 114 -------
 115 * amitu: ajax in views page
 116 * ashweta: main view page for words
 117 * amitu: ajax views
 118 * amitu: generic ajax form view
 119 * amitu: registration/activation/login/logout etc done
 120 * amitu: enabled admin site.
 121 * amitu: added dmigration app, and created migration rules for base apps.
 122
 123 .. Hyper link targets ..
 124
 125 .. _RestructuredText:
 126    http://docutils.sourceforge.net/docs/user/rst/quickref.html
 127 .. _restview: http://mg.pov.lt/restview/
 128 .. _dmigration: http://code.google.com/p/dmigrations/wiki/DmigrationsTutorial
 129 .. _wiktionary: http://en.wiktionary.org/wiki/game
 130 .. _`mariam webster`: http://www.merriam-webster.com/dictionary/games
 131 .. _answers.com: http://www.answers.com/game
 132 .. _thesaurus: http://education.yahoo.com/reference/thesaurus/entry/game
 133
 134 .. role:: raw-html(raw)
 135       :format: html
 136