semanticeditor / INSTALL.rst

Luke Plant 1d2fbaf 













aiki...@localhos… 831d439 
Luke Plant 1d2fbaf 




Luke Plant ff92e95 
Luke Plant 1d2fbaf 
aiki...@localhos… 831d439 
Luke Plant 1d2fbaf 









Luke Plant ff92e95 

Luke Plant 1d2fbaf 



















Package install
===============

The 'semanticeditor' package must be on your Python path, by whatever
method. (It can be installed from PyPI using easy_install/pip, or use the
setup.py in the downloaded package in the normal way).

Dependencies
============

 * Django, tested with Django 1.1
 * django-cms2, tested on r172 or later
 * lxml, tested with 2.2.4
 * pyquery, tested with 0.3.1
 * Javascript dependencies are included in static/

Settings
========

 * Normal Django settings
 * Normal django-cms settings
 * INSTALLED_APPS - add "semanticeditor"
 * SEMANTICEDITOR_MEDIA_URL = os.path.join(STATIC_URL, "semanticeditor/")

Templates
=========

Automatically found if 'django.template.loaders.app_directories.load_template_source'
is in TEMPLATE_LOADERS.

Media
=====

Media files: /semanticeditor/static needs to be copied/linked/served so that it is
under STATIC_URL. (The normal collectstatic tool should do this).

URLS
====

Add the following to the root URL conf::

  (r'^semantic/', include('semanticeditor.urls')),

These are needed for views.

Models
======

Install the models::

  ./manage.py syncdb

Or, if you have South installed (recommended)::

  ./manage.py migrate semanticeditor
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.