improved documentation, fixed a few minor things. ready for merging search with master !

albanm · albanm · commit 0517aa6dea71 · 2011-08-09T08:45:36.000+02:00
diff --git a/djity/project_skeleton/local_settings.py_tmpl b/djity/project_skeleton/local_settings.py_tmpl
@@ -32,6 +32,9 @@ DEBUG = {develop!r}
 TEMPLATE_DEBUG = DEBUG
 DEBUG_TOOLBAR = DEBUG
 
+DEBUG_TOOLBAR_CONFIG = {{}}
+DEBUG_TOOLBAR_CONFIG["INTERCEPT_REDIRECTS"] = False
+
 if DEBUG :
     LOG_LEVEL = 'DEBUG'
 else:
diff --git a/docsrc/source/admin/commands.rst b/docsrc/source/admin/commands.rst
@@ -0,0 +1,22 @@
+Project management commands
+===========================
+
+ * Prepare the databases. Useful in particular if you wish to update Djity for an existing project, or are modifying the models of an application used by the current project. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py syncdb
+ 
+ * Create initial data for an empty project. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py create_portal
+  
+ * Run development server. (This is used automatically if you select the development mode of `djity-admin.py create_project`)::
+ 
+    $ python manage.py runserver
+  
+ * Update search indexes. When the data of indexable contents from a project is modified, you should update all search indexes::
+ 
+    $ python manage.py update_indexes --using=all
+  
+ * Install an application in the current project. You can use `djity-admin.py ls_apps` to list all installed apps in the system::
+ 
+    $ python manage.py install_app <app>
diff --git a/docsrc/source/admin/index.rst b/docsrc/source/admin/index.rst
@@ -0,0 +1,10 @@
+Administration guide
+====================
+
+Administrate a Djity based website. Still very raw.
+
+.. toctree::
+    :maxdepth: 2
+
+    commands.rst
+
diff --git a/docsrc/source/developer/documentation.rst b/docsrc/source/developer/documentation.rst
diff --git a/docsrc/source/developer/environment.rst b/docsrc/source/developer/environment.rst
@@ -4,7 +4,7 @@ Development environment
 Virtualenv
 ++++++++++
 
-A virtual environment is mostly useful for a developer's working environment and more generally to put djity in a box separated from the rest of your system. You are free to skip this part if it is not relevant to your needs.
+A virtual environment is mostly useful for a developer's working environment and more generally to put Djity in a box separated from the rest of your system. You are free to skip this part if it is not relevant to your needs.
 See `<http://virtualenv.openplans.org/>`_, and `<http://www.doughellmann.com/projects/virtualenvwrapper/>`_ to learn more about the tools we recommend.
 You will need to have virtualenvwrapper installed, you can find installation instructions here: `<http://www.doughellmann.com/docs/virtualenvwrapper/install.html#basic-installation>`_.
 
@@ -33,7 +33,7 @@ Afterwards, each time you want to work with djity you should type something like
 
 	$ workon djity
 
-You can exit this environement with the deactivate command::
+You can exit this environment with the deactivate command::
 
 	$ deactivate
 
@@ -85,10 +85,16 @@ You have to install :
 
    $ sudo apt-get install python-imaging
    
+ * `Haystack <http://haystacksearch.org/>`_ (through our fork on github because of added features)::
+ 
+   $ git clone https://github.com/albanm/django-haystack haystack
+   $ cd haystack
+   $ python setup.py install
+   
 Optional dependences
 --------------------
 
- * `Django Debug Toolbar <http://robhudson.github.com/django-debug-toolbar/>`_ (useful for developpers and required by option 'develop' of 'djity-admin.py create_project')::
+ * `Django Debug Toolbar <http://robhudson.github.com/django-debug-toolbar/>`_ (useful for developers and required by option 'develop' of 'djity-admin.py create_project')::
 
    $ pip install django-debug-toolbar
 
@@ -108,15 +114,15 @@ without repeating the installation::
 
 	$ python setup.py develop
 
-Non-contributors Web admins or application developpers should probably use the 'install' command::
+Non-contributors Web admins or application developers should probably use the 'install' command::
 
 	$ python setup.py install
 
 
 Setup of a new project
 ++++++++++++++++++++++
 
-Now that djity and all its required packages are installed you can create a new development project::
+Now that Djity and all its required packages are installed you can create a new development project::
 
 	$ djity-admin.py create_project /path/to/my/project
 
diff --git a/docsrc/source/developer/index.rst b/docsrc/source/developer/index.rst
@@ -1,17 +1,15 @@
-Developers Guide
+Developers guide
 ================
 
 
-This guide is write for programers wishing improve Djity itself. 
+This guide is written for programmers wishing to improve Djity itself or develop applications for Djity. 
 
 
 .. toctree::
 	:maxdepth: 2
 
 	environment.rst
-	documention.rst	
+	documentation.rst	
 	localization.rst
-	communication.rst
-	role.rst
-	conventions.rst
+
 
diff --git a/docsrc/source/developer/localization.rst b/docsrc/source/developer/localization.rst
@@ -1,16 +1,16 @@
-Language Localisation
+Language localization
 =====================
 
-Instructions below are for localisation/internationalization of Djity. However
+Instructions below are for localization/internationalization of Djity. However
 Djity applications being organized in a very similar way, applications
-developpers could be interested as well.
+developers could be interested as well.
 
 Interface localisation
 ++++++++++++++++++++++
 
-Djity uses Django in a pretty standard way for internalization/localisation `<http://docs.djangoproject.com/en/dev/topics/i18n/>`_.
+Djity uses Django in a pretty standard way for internalization/localization `<http://docs.djangoproject.com/en/dev/topics/i18n/>`_.
 
-Messages are generated in the locale directory of djity's package. Commands
+Messages are generated in the locale directory of Djity's package. Commands
 below should be used in the directory of Djity's main package (directory 'djity' in root).
 
 A new language translation (chinese in the example below) for python file and template can be added by ::
@@ -32,7 +32,7 @@ afterwards. ::
  django-admin.py compilemessages
 
 
-User content localisation
+User content localization
 +++++++++++++++++++++++++
 
 Djity allows its users to define multi-language contents without any particular
diff --git a/docsrc/source/index.rst b/docsrc/source/index.rst
@@ -52,6 +52,7 @@ Incoming features
 	
 	tutorial/index.rst
 	developer/index.rst
+	admin/index.rst
 	api/modules.rst
 
 
diff --git a/docsrc/source/settings.py b/docsrc/source/settings.py
@@ -37,26 +37,28 @@
 TIME_FORMAT = None 
 # Absolute path to the directory that holds media. Example: "/home/media/media.lawrence.com/"
 MEDIA_ROOT = "%s/media" % PROJECT_ROOT
+STATIC_ROOT = "%s/static" % PROJECT_ROOT
 
 # Absolute path to the directory containing data for this intance of djity
 DATA_DIR = "%s/data" % PROJECT_ROOT
 
 # Djity's themeroller textures and icons directories
-TEXTURES_DIR = "%s/images/textures/" % MEDIA_ROOT
-ICONS_DIR = "%s/images/icons/" % MEDIA_ROOT
+TEXTURES_DIR = "%s/djity/images/textures/" % STATIC_ROOT
+ICONS_DIR = "%s/djity/images/icons/" % STATIC_ROOT
 
 # URL that handles the media served from MEDIA_ROOT. Make sure to use a
 # trailing slash if there is a path component (optional in other cases).
 # Examples: "http://media.lawrence.com", "http://example.com/media/"
 MEDIA_URL = '/site_media/'
+STATIC_URL = '/site_static/'
 
 # URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a trailing slash. Examples: "http://foo.com/media/", "/media/".
 ADMIN_MEDIA_PREFIX = '/media/'
 
 DAJAXICE_MEDIA_PREFIX="dajaxice" # Will create http://yourdomain.com/dajaxice/...
 
 # Make this unique, and don't share it with anybody.
-SECRET_KEY = '+uf*31w)3i8w74)1(^6u%utlfyb^lzu_1_4rqt=+c55v*=lj3g'
+SECRET_KEY = 't%u=6xy3=1bhbf$2us1ekf4l8o(jiq_-!m&j=&ckd0u03dfh(1'
 
 # List of callables that know how to import templates from various sources.
 TEMPLATE_LOADERS = (
@@ -69,6 +71,7 @@
     'localeurl.middleware.LocaleURLMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
+    'django.middleware.csrf.CsrfResponseMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
@@ -85,6 +88,7 @@
     'django.core.context_processors.media',
     'django.core.context_processors.request',
     'django.contrib.messages.context_processors.messages',
+    'django.core.context_processors.static',
 )
 
 INSTALLED_APPS = [
@@ -97,25 +101,28 @@
     'django.contrib.sessions',
     'django.contrib.sites',
     'django.contrib.markup',
-    'django.contrib.admin',
     'django.contrib.messages',
     'django.contrib.comments',
+    'django.contrib.staticfiles',
 
     #extensions
-    'django_extensions',
-    'tagging',
 
     # Dajax
     'dajaxice',
     'dajax',
 
+    # Haystack for search
+    'haystack',
+
     #Djity Core
+    'djity',
     'djity.portlet',
     'djity.style',
     'djity.portal',
     'djity.project',
     'djity.simplepage',
     'djity.transmeta',
+    'djity.search',
 ]
 
 ###########################################
@@ -155,6 +162,15 @@
 # list of permissions to check when updating djity's context
 PERMISSIONS = ['view','edit','upload','manage']
 
+# List of visible statuses according to role (used to filter search results)
+HIDDEN_STATUSES = {
+    ANONYMOUS:[DRAFT,PRIVATE],
+    AWAITING:[DRAFT,PRIVATE],
+    USER:[DRAFT],
+    CONTRIBUTOR:[],
+    MANAGER:[],
+}
+
 # Status display in user interface
 STATUS_DISPLAY = [[DRAFT,'Draft'],[PRIVATE,'Private'],[PUBLIC,'Public']]
 
@@ -185,6 +201,7 @@
 LANGUAGES = (
     ('en', ugettext(u'English')),
     ('fr', ugettext(u'Français')),
+    ('zh', ugettext(u'中文')),
 )
 
 USE_L10N = True
@@ -198,6 +215,34 @@
 
 FIXTURE_DIRS = 'data/fixtures'
 
+###########################
+# Djity indexing settings #
+###########################
+
+# Haystack search engine connections configuration
+HAYSTACK_CONNECTIONS = {'default':{
+        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
+        'PATH': '%s/data/whoosh/djity_index/default' % (PROJECT_ROOT),
+        'STORAGE': 'file',
+        'POST_LIMIT': 128 * 1024 * 1024,
+        'INCLUDE_SPELLING': True,
+        'BATCH_SIZE': 100,
+    }
+}
+
+for (language,language_repr) in LANGUAGES:
+    HAYSTACK_CONNECTIONS['default_'+language] = {
+        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
+        'PATH': '%s/data/whoosh/djity_index/%s' % (PROJECT_ROOT,language),
+        'STORAGE': 'file',
+        'POST_LIMIT': 128 * 1024 * 1024,
+        'INCLUDE_SPELLING': True,
+        'BATCH_SIZE': 100,
+        'LANGUAGE': '%s' % language
+    }
+    
+HAYSTACK_ROUTERS = ['haystack.routers.LanguageRouter']
+
 ###################################################################
 # Import local settings and those from djity apps                 #
 ###################################################################
@@ -206,5 +251,6 @@
 # in local_settings.py
 
 DJITY_APPS = []
-
 DEFAULT_STYLE = []
+
+
