2010-11-26 06:19:58 +01:00
|
|
|
===============
|
|
|
|
django-microcms
|
|
|
|
===============
|
2010-11-16 15:01:44 +01:00
|
|
|
|
2010-11-26 06:19:58 +01:00
|
|
|
``django-microcms`` is a minimalistic enhancement of Django flatpages app. It
|
|
|
|
provides few additional fields and integrates CKeditor.
|
2010-11-16 15:01:44 +01:00
|
|
|
|
|
|
|
Installation
|
|
|
|
============
|
|
|
|
|
2012-11-24 23:34:27 +01:00
|
|
|
Assuming that you want to install ``django-microcms`` version 0.2.0:
|
2010-11-26 06:19:58 +01:00
|
|
|
|
|
|
|
From a packaged version::
|
|
|
|
|
2012-11-24 23:34:27 +01:00
|
|
|
$ pip install http://downloads.mornie.org/django-microcms/django-microcms-0.2.0.tar.gz
|
2010-11-16 15:01:44 +01:00
|
|
|
|
2010-11-26 06:19:58 +01:00
|
|
|
From source repository::
|
2010-11-16 15:01:44 +01:00
|
|
|
|
2012-11-24 23:34:27 +01:00
|
|
|
$ pip install -e hg+http://hg.mornie.org/django/microcms/@0.2.0#egg=django-microcms
|
2010-11-26 06:19:58 +01:00
|
|
|
|
|
|
|
Or download a packaged version from http://downloads.mornie.org/django-microcms/
|
|
|
|
and and use Python's ``distutils`` to install.
|
2010-11-16 15:01:44 +01:00
|
|
|
|
|
|
|
Getting started
|
|
|
|
===============
|
|
|
|
|
|
|
|
Previously you must have correctly set up Django ``flatpages``.
|
|
|
|
|
2010-11-26 06:19:58 +01:00
|
|
|
Simply add ``microcms`` to your ``INSTALLED_APPS`` after ``flatpages``.
|
2010-11-16 15:01:44 +01:00
|
|
|
|
|
|
|
CKeditor integration
|
|
|
|
====================
|
|
|
|
|
|
|
|
Default settings assumes that CKeditor is available at
|
2012-11-24 23:34:27 +01:00
|
|
|
``STATIC_URL/ckeditor/ckeditor.js``. You can change it using CKEDITOR_URL in
|
2010-11-16 15:01:44 +01:00
|
|
|
your settings.py:
|
|
|
|
|
|
|
|
CKEDITOR_URL = "path/to/ckeditor.js"
|
|
|
|
|
2012-11-24 23:34:27 +01:00
|
|
|
CKEDITOR_URL will be prepended with STATIC_URL so you can use a relative path.
|
2010-11-16 15:01:44 +01:00
|
|
|
|
|
|
|
You can need to add some custom css to fix displaying issues or to customize the
|
2012-11-24 23:34:27 +01:00
|
|
|
admin page. CKeditor kama theme, for example, doesn't look good without a fix,
|
|
|
|
but a custom css is provided by django-microcms itself: just use
|
|
|
|
``django-admin.py collectstatic`` to copy it into STATIC_ROOT.
|
|
|
|
|
|
|
|
If you want customize just use MICROCMS_CUSTOM_CSS in your settings.py:
|
2010-11-16 15:01:44 +01:00
|
|
|
|
|
|
|
MICROCMS_CUSTOM_CSS = ('kama-fix.css',)
|
|
|
|
|
|
|
|
Don't forget to use a tuple: this is done to give greater flexibility. Again
|
2012-11-24 23:34:27 +01:00
|
|
|
values inside MICROCMS_CUSTOM_CSS will be prepended with STATIC_URL.
|
2010-11-26 06:19:58 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Thanks for downloading django-microcms.
|