Installation

Installation of Darcsforge components is intended to be similar to the installation of any other Django applications. It is suggested that users should be familiar with Django.

Contents

• Installation
  • Dependencies
  • Django Settings

Dependencies

See also

Python

Python is the language of choice.

Django Framework

Django provides the fundamental web stack used by Darcsforge.

reStructuredText

reStructuredText is the dominant markup language for Darcsforge.

Pygments

Pygments is a Python syntax colorizer used by several parts of Darcsforge.

django-mptt

MPTT provides a standardized way of dealing with tree models in Django, by optimizing for the common case (retrieval queries) with a small expense to the insertion and deletion queries. (This is a near future dependency.)

Additionally, to build this documentation you will need the Sphinx documentation tool.

Django Settings

These are settings for your settings.py that affect operation of Darcsforge applications.

DARCSFORGE_CONTENT_FORMATTER

The Content Formatter is the deep-linker and markup engine for most Darcsforge entities. The encouraged formatter is for reStructuredText, and is a component of darcsforge.deepdish. To use this formatter:

# Darcsforge Markup Setting
from darcsforge.deepdish.formatters import ReStructuredText
DARCSFORGE_CONTENT_FORMATTER = ReStructuredText

INSTALLED_APPS

Most Darcsforge applications contain models. It is suggested to refer to individual application modules for more details on whether to install them or not. Don’t forget to python manage.py syncdb when installing new applications.

SITE_ID

Most Darcsforge applications use references to the django.contrib.sites.Site model and it is suggested that your sites correctly set SITE_ID.