Overview

Installation Instructions
=========================

Once you have cloned transifex, you clone the foxlotte repo and then
edit transifex/settings/89-addons.conf adding the following line:

ADDONS_ROOTS.append('/path/to/mozilla-addons')

To make sure it is working issue the command ./manage.py addons and you should
get a list with all enabled addons including foxcore/foxlotte.

In order to completely setup transifex you issue this command
`./manage.py syncdb --noinput && ./manage.py migrate && ./manage.py
txcreatenoticetypes && ./manage.py txlanguages && ./manage.py
createsuperuser`

After that, the Transifex instance is ready to be used. foxcore includes the
push/pull strings and exception API calls and the enhancements in the data
model. To test the API, you create a project named `foo` and add strings using
the common-pool client[1]. After that you have access to the API calls from the
following urls (mozilla is just a keyword we're using in order to avoid with
the rest of the API calls which are under /api/. This will be changed to
something better in time):

http://host/mozillla/foo/strings - To pull/push strings from/to the database

http://host/mozillla/foo/overrides - To pull exceptions from the database

Available API options are :
 * strings: Search for specific strings (eg ?strings=next,cancel)
 * jetpacks: Search for strings inside these jetpacks (eg
	?jetpacks=testpack,testpack2)
 * languages: Return translations in these languages (eg ?languages=el,fr,de)
 * (only available in strings handler) partial: If set to 1, the API
will return partial translations for languages that are not 100%
completed. The default behaviour is to return 100% translation by
using the fallback mechanism**

** The fallback mechanism has two modes of operation. It can do a
complete fallback (eg if pt_BR is not 100% return the complete
translation in pt) or do partial fallbacks (eg if a string is not
translated in pt_BR fetch the pt translation. The returned stringset
is a mix of various languages this way). This behavious can be changed
by editing settings/00-base.conf of foxcore.


[1] http://bitbucket.org/indifex/commonpool-client