1. General Documentation

• Tutorial - Very short tutorial on what needs to be done to start a new project from scratch which utilizes the wiki and board.

• Applications

  • Community - General purpose features like user profiles
  • Wiki - Easiest way to add content to your site ;)
  • Board/Forum - Full featured Forum application (Message Board).
  • LinkList - A simple linklist application.
  • Blog

• Contributing - If you want to help and improve SCT read here what you can do

• SPH SETTINGS - global Sphene Community Tools settings configured in your settings.py

• Documentation TODOs

  • Development
  • Blog
  • BlockFramework

2. Download

See Downloads Section.

3. README

3.1. Directories

• sphenecoll/ Collection of django application (the base source for SCT).
• static/ Static media files which contain images and css.

3.2. Requirements

• Django trunk (NOT compatible with 0.96)
• Python >= 2.4 (Use >= 2.5 if you need wiki diffs with unicode support)
• PyCrypto - (e.g. debian package python-crypto)
• Python Imaging Library (PIL)

3.3. Installation

3.3.1. Django bug workarounds

The current django trunk contains a bug in the select_related method.

To workaround the problem (ie. don't use it) you need to activate the following setting:

SPH_SETTING['workaround_select_related_bug'] = True

See http://code.djangoproject.com/ticket/4789 - If this patch was already committed or you applied it manually you can disable the workaround to improve performance.

3.3.2. Python library path

You need to add sphenecoll/ to your python include path and static/ needs to be served from your django installation. (static/sphene/ is enough)

3.3.3. Maintenance cron job (Optional)

To recaulcate heat for forum threads and similar, you should add the following cronjob to run once a day (or similar)

echo -e "from sphene.community.signals import trigger_maintenance\ntrigger_maintenance()" | ./manage.py shell --plain

3.3.4. Cache

SCT makes use of django caching framework - it is therefore advised to configure CACHE_BACKEND django setting & co. look at the django caching documentation

4. Examples

The most complete example on how to use SCT in a web site is the CommunityDraft - it is bundled in releases and is the best way to get started. (http://sct.sphene.net uses an unmodified version of CommunityDraft)

SCT also contains a very simplistic example under communitytools/examples/simpleproject (see Tutorial).