Permalink
Browse files

docs

git-svn-id: http://svn.django-cms.org/branches/django-cms2@297 92ec8317-e278-4cfe-9719-05471b91e6e2
  • Loading branch information...
divio
divio committed Mar 30, 2009
1 parent ae014e2 commit 2b550e38dfd0fccdcd86eaa1cbaf65aeeedb5e97
Showing with 260 additions and 246 deletions.
  1. +8 −9 AUTHORS
  2. +0 −88 INSTALL
  3. +0 −21 README
  4. +28 −0 README.md
  5. +17 −17 cms/docs/{i18n.txt → i18n.md}
  6. +90 −0 cms/docs/installation.md
  7. +79 −76 cms/docs/{navigation.txt → navigation.md}
  8. +38 −35 cms/docs/{plugins.txt → plugins.md}
View
17 AUTHORS
@@ -1,15 +1,14 @@
Django CMS
==========
-Patrick Lauber
-Jason Zylks
+* Patrick Lauber
+* Jason Zylks
Django Page CMS
===============
-Batiste Bieler
-Jannis Leidel
-Antoni Aloy López
-Benjamin Wohlwend
-poweredbypenguins
-homebrew79
-
+* Batiste Bieler
+* Jannis Leidel
+* Antoni Aloy López
+* Benjamin Wohlwend
+* poweredbypenguins
+* homebrew79
View
88 INSTALL
@@ -1,88 +0,0 @@
-Installation
-============
-
-copy the cms and mptt folder into your project or pythonpath
-
-Apps
-----
-
-add the following to your INSTALLED_APPS in your settings.py:
-
-INSTALLED_APPS = (
- ...
- 'cms',
- 'cms.plugins.text',
- 'cms.plugins.picture',
- 'mptt',
- ...
-
-Django-cms 2.0 is compatible with django-reversion for versioning all the page content and its plugins.
-
-Middleware
-----------
-
-add the following middlewares:
-
-MIDDLEWARE_CLASSES = (
- ...
- 'cms.middleware.CurrentSiteMiddleware',
- 'cms.middleware.CurrentPageMiddleware',
- 'cms.middleware.MultilingualURLMiddleware',
- )
-
-If your site is not multilingual you can leave out the MutilingualURLMiddleware
-
-Context Processors
-------------------
-add the following context processors if not already present:
-
-TEMPLATE_CONTEXT_PROCESSORS = (
- ...
- "django.core.context_processors.request",
- "cms.context_processors.media",
- )
-
-Templates
----------
-
-Add some template names you use and that have some placeholder templatetags present
-
-CMS_TEMPLATES = (
- ('base.html', gettext('default')),
- ('2col.html', gettext('2 Column')),
- ('3col.html', gettext('3 Column')),
- ('extra.html', gettext('Some extra wired template')),
-)
-
-For some template examples see the templates used in the example project
-
-a quick example:
-
-{% load cms_tags %}
-
-<div id="menu">{% show_menu 0 100 100 100 %}</div>
-<div id="breadcrumb">{% show_breadcrumb %}</div>
-<div id="languagechooser">{% language_chooser %}</div>
-<div id="content">{% placeholder "content" %}</div>
-<div id="left_column">{% placeholder "left_column" %}</div>
-
-i18n
-----
-
-If your site is multilingual be sure to have the LANGUAGES present in your settings:
-
-LANGUAGES = (
- ('fr', gettext('French')),
- ('de', gettext('German')),
- ('en', gettext('English')),
-)
-
-Other settings
---------------
-
-For a list of all settings that can be overwritten in your settings.py have a look at cms/settings.py
-
-More information is available in the docs folder: cms/docs/
-or have a look at the example project
-
-
View
21 README
@@ -1,21 +0,0 @@
-Django CMS 2.0
-==============
-
-A django app for managing hierarchical pages of content in multiple languages, on different sites.
-
-Django CMS handles the navigation rendering for you in multiple language with i18n slugs
-and the navigation can be extended by your own models.
-
-Pages are rendered with a template that have placeholders that get filled with plugins.
-
-Plugins included at the moment:
-
-Text
-Picture
-Flash
-
-Plugins are very easy to write and you can easily connect pages with your own models.
-
-For a feature comparison of all the cms apps available for django see: http://code.djangoproject.com/wiki/CMSAppsComparison
-
-visit django-cms.org or #django-cms on freenet for more info
View
@@ -0,0 +1,28 @@
+Django CMS 2.0
+==============
+
+A django app for managing hierarchical pages of content in multiple languages, on different sites.
+
+Django CMS handles the navigation rendering for you in multiple language with i18n slugs
+and the navigation can be extended by your own models.
+
+Pages are rendered with a template that have placeholders that get filled with plugins.
+
+Plugins included at the moment:
+
+* Text
+* Picture
+* Flash
+
+many more are in the works.
+
+Plugins are very easy to write and you can easily write them on your own and connect them with your own models.
+
+For a feature comparison of all the cms apps available for django see: [CMSComparison](http://code.djangoproject.com/wiki/CMSAppsComparison)
+
+Install instructions you can find in the docs [here](http://github.com/digi604/django-cms-2.0/tree/master/cms/docs).
+
+visit [django-cms.org](http://www.django-cms.org/) or #django-cms on freenet for more info
+
+This is a fork of django-page-cms and the main differences are the plugin system and performance improvements.
+
@@ -8,8 +8,8 @@ the multilingual url middleware adds a language prefix to every url.
Example:
-/de/account/login/
-/fr/account/login/
+ /de/account/login/
+ /fr/account/login/
It also adds this prefix automatically to every href and form tag.
@@ -22,41 +22,41 @@ The template in cms/language_chooser.html may be overwritten or your own templat
Example:
-{% load cms_tags %}
-{% language_chooser "myapp/language_chooser.html" %}
+ {% load cms_tags %}
+ {% language_chooser "myapp/language_chooser.html" %}
If the current url is not handled by the cms and you have some i18n slugs in the url you may use
-the set_language_changer function in the view that handles the current url:
+the set\_language\_changer function in the view that handles the current url:
-in the models of the current object add a optional language parameter to the get_absolute_url function:
+in the models of the current object add a optional language parameter to the 'get_absolute_url' function:
-def get_absolute_url(self, language=None):
- reverse("product_view", args=[self.get_slug(language=language)])
+ def get_absolute_url(self, language=None):
+ reverse("product_view", args=[self.get_slug(language=language)])
-In the view pass the set_language_changer the get_absolute_url function to the set_language_chooser function:
+In the view pass the set_language_changer the get\_absolute\_url function to the set\_language\_chooser function:
-from cms.utils import set_language_changer
+ from cms.utils import set_language_changer
-def get_product(request, slug):
- item = get_object_or_404(Product, slug=slug, published=True)
- set_language_changer(request, item.get_absolute_url)
- ...
+ def get_product(request, slug):
+ item = get_object_or_404(Product, slug=slug, published=True)
+ set_language_changer(request, item.get_absolute_url)
+ ...
This allows that the language chooser has an other url then the current one.
-If the current url is not handled by the cms and no set_language_changer function is provided it will take the exact
+If the current url is not handled by the cms and no set\_language\_changer function is provided it will take the exact
same url as the current and only will change the language prefix.
For the language chooser to work the MultilingualURLMiddleware must be installed.
page_language_url
-----------------
-This tempalte_tag returns the url of the currentpage in an other language.
+This template_tag returns the url of the current page in an other language.
Example:
-{% page_language_url "de" %}
+ {% page_language_url "de" %}
View
@@ -0,0 +1,90 @@
+Installation
+============
+
+copy the cms and mptt folder into your project or pythonpath
+
+Apps
+----
+
+add the following to your INSTALLED_APPS in your settings.py:
+
+ INSTALLED_APPS = (
+ ...
+ 'cms',
+ 'cms.plugins.text',
+ 'cms.plugins.picture',
+ 'mptt',
+ ...
+
+Django-cms 2.0 is compatible with django-reversion for versioning all the page content and its plugins.
+
+Middleware
+----------
+
+add the following middlewares:
+
+ MIDDLEWARE_CLASSES = (
+ ...
+ 'cms.middleware.CurrentSiteMiddleware',
+ 'cms.middleware.CurrentPageMiddleware',
+ 'cms.middleware.MultilingualURLMiddleware',
+ ...
+ )
+
+If your site is not multilingual you can leave out the MutilingualURLMiddleware
+
+Context Processors
+------------------
+add the following context processors if not already present:
+
+ TEMPLATE_CONTEXT_PROCESSORS = (
+ ...
+ "django.core.context_processors.request",
+ "cms.context_processors.media",
+ ...
+ )
+
+Templates
+---------
+
+Add some template names you use and that have some placeholder templatetags present to your settings.py
+
+ CMS_TEMPLATES = (
+ ('base.html', gettext('default')),
+ ('2col.html', gettext('2 Column')),
+ ('3col.html', gettext('3 Column')),
+ ('extra.html', gettext('Some extra wired template')),
+ )
+
+For some template examples see the templates used in the example project
+
+a quick example:
+
+ {% load cms_tags %}
+
+ <div id="menu">{% show_menu 0 100 100 100 %}</div>
+ <div id="breadcrumb">{% show_breadcrumb %}</div>
+ <div id="languagechooser">{% language_chooser %}</div>
+ <div id="content">{% placeholder "content" %}</div>
+ <div id="left_column">{% placeholder "left_column" %}</div>
+
+i18n
+----
+
+If your site is multilingual be sure to have the LANGUAGES present in your settings:
+
+ LANGUAGES = (
+ ('fr', gettext('French')),
+ ('de', gettext('German')),
+ ('en', gettext('English')),
+ )
+
+Other settings
+--------------
+
+For a list of all settings that can be overwritten in your settings.py have a look at cms/settings.py
+
+More information is available in the docs folder: cms/docs/
+or have a look at the example project
+
+
Oops, something went wrong.

0 comments on commit 2b550e3

Please sign in to comment.