Difference between revisions of "Artenquiz documentation"

Revision as of 08:30, 2 July 2013

(See also Django-Installation and Django at a glance)

The test version for Artenquiz is running under:

• http://artenquiz.de/
• http://artenquiz.de/identification/ (Test with additional keys: http://artenquiz.de/identification_test/)
• http://artenquiz.de/identification_mobile/ (Test with additional keys: http://artenquiz.de/identification_mobile_test/)

An admin interface for django users having a special admin account is available at:

• http://artenquiz.biowikifarm.net/admin/
• http://artenquiz.biowikifarm.net/admin/doc/ (automatic documentation generated if Python's docutils is available)

Subversion directory is:

• https://biowikifarm.net/svn/artenquiz/ (you must be e registered user for svn to get access)
• Schema diagram at:
  http://biowikifarm.net/v-artenquiz/django/doc/current_artenquiz_schema.png
  http://biowikifarm.net/v-artenquiz/django/doc/current_artenquiz_schema.pdf

Folder structure

/var/www/v-artenquiz/django/
 ├ /apache  (redirect/URL settings) 
 ├ /artenbestimmung  (projects artenquiz + artenbestimmung) 
 ·   http://artenquiz.biowikifarm.net/
 ·   http://artenquiz.biowikifarm.net/identification/
 ·   /accounts  (backend for user_name or email login) 
 ·   /artenquiz
 ·     /management
 ·       /commands  (various import tools) 
 ·        USAGE: 
 ·          cd /path-to/artenbestimmung  
 ·          python manage.py help importtaxa  
 ·          python manage.py importtaxa /path-to/datafile.csv 
 ·     /templatetags  (custom tags used in templates) 
 ·     /static  (static CSS styles, JavaScript files, icons) 
 ·     /tools  (python script tools) 
 ·   /local  (generated localization files and defined English translations) 
 ·   /register  (definitions of registration) 
 ·   /report  (simple reports of descriptions for admins) 
 ·   /templates  (all django XHTML-templates and page texts) 
 ├ /data  (data for import) 
 └ /doc  (python + django documentation as freemind-mind-map; current database schema)

Create a new project

You can start a django app by:

  cd my-dj-project-folder 
  django-admin.py help startapp 
   django-admin.py startapp my-app-folder 
  # a it needs always __init__.py!!!!

To let a django application get to work, you need (in general) the following files:

__init__.py   (a 0Byte file needed by python) 
url.py  (URL pattern definitions) 
models.py  (data-model definitions) 
views.py  (view layer: form request definitions, form processing) 
mytemplate.html  (a template to process, see also admin/doc/) 

Create first model

After setting the database a first autgenerated model can be obtained by

 cd /artenquiz/django/artenbestimmung
 python manage.py inspectdb
 python manage.py inspectdb > models_autogenerated.py
 mv --interactive  models_autogenerated.py models.py

Change translations

(1)

<!-- in /templates/mytemplate.html -->
  {% trans "Short localised message" %}
  {% blocktrans %}Localised message 
  spanning multiple lines{% endblocktrans %}
<!-- in /templates/mytemplate.html -->

(2)

# move to base directory of artenquiz app 
cd /artenquiz/django/artenbestimmung
django-admin.py help makemessages # show the help
django-admin.py makemessages --no-wrap -l de --extension='.html,.txt' && django-admin.py makemessages  --no-wrap -l en --extension='.html,.txt'

(3) Add translations at least in

• /artenbestimmung/locale/de/LC_MESSAGES/django.po
• note that #, fuzzy becomes not translated, you may remove it and make sure you have an exact msgid or change it to #, use-fuzzy (?undocumented hack? because msgfmt has msgfmt --use-fuzzy)

(4)

# move to base directory of artenquiz app 
cd /artenquiz/django/artenbestimmung
django-admin.py compilemessages

(5) (eventually) restart the server

sudo /usr/sbin/apache2ctl -k graceful # or not graceful: sudo /usr/sbin/apache2ctl -k restart