Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

docs updated. fixes #281

  • Loading branch information...
commit 2ce9214320bc3e9a9418db98f54e7bbf85427fc5 1 parent f826ecf
@digi604 digi604 authored
View
21 cms/docs/configuration.txt
@@ -288,19 +288,8 @@ Example::
Normally the cms takes the LANGUAGES from the settings.py. With this you can overwrite this. Be sure that you don't have more language in here than in the LANGUAGES setting.
-
-CMS_DEFAULT_LANGUAGE
-----------------------
-
-Example::
-
- CMS_DEFAULT_LANGUAGE = "de"
-
-The default language is used if no other language could be found in the browser. Normally it will take the first of the LANGUAGES setting.
-
-
CMS_CONTENT_CACHE_DURATION
------------------------------
+--------------------------
Example::
@@ -311,7 +300,7 @@ Defines how long page content should be cached, including navigation and admin m
Default is 60
CMS_MEDIA_PATH
-----------------
+--------------
Example::
@@ -322,7 +311,7 @@ The path from MEDIA_ROOT to the media files located in ``cms/media/``
default: ``cms/``
CMS_MEDIA_ROOT
-----------------
+--------------
Example::
@@ -333,7 +322,7 @@ The path to the media root of the cms media files.
Default: ``settings.MEDIA_ROOT + CMS_MEDIA_PATH``
CMS_MEDIA_URL
----------------
+-------------
Example::
@@ -344,7 +333,7 @@ The location of the media files that are located in cms/media/cms/
default: ``MEDIA_URL + CMS_MEDIA_PATH``
CMS_PAGE_MEDIA_PATH
-----------------------
+-------------------
By default the cms creates a folder in called 'cms_page_media' in your static files folder where all uploaded media files are stored.
The media files are stored in subfolders numbered with the id of the page.
View
8 cms/docs/contribution.txt
@@ -5,7 +5,7 @@ Translators
-----------
For translators we have a `transifex account <http://www.transifex.net/projects/p/django-cms/>`_
-where you can translate the .po files and don't need install git or mercurial to be able to contribute.
+where you can translate the .po files and don't need to install git or mercurial to be able to contribute.
All changes there will be automatically sent to the project.
Developers
@@ -81,9 +81,9 @@ or::
Now your repository is up-to-date again.
-It is also good practice to use a branch for every bug / feature you commit if you have more than one.
-So we can merge the whole branch and don't have to cherry-pick the single commits that make up the fix / feature.
-Also it allows us to give you instructions as if something is missing (tests, docs) and you don't have to interfere
+It is also good practice to use a branch for every bug / feature you commit if you have more than one or you need more then one commit.
+This helps that we can merge the whole branch and don't have to cherry-pick the single commits that make up the fix / feature.
+Also it allows us to give you instructions if something is missing (tests, docs) and you don't have to interfere
with other things you might be working on.
If you have questions you may wish to read some tutorials about git or Mercurial
View
6 cms/docs/custom_plugins.txt
@@ -71,15 +71,15 @@ Will be rendered with the context returned by the render function
The render function takes 3 arguments:
-**context**:
+***context***:
The context of the template placeholder was placed.
-**instance**:
+***instance***:
The instance of the GalleryPlugin model
-**placeholder**:
+***placeholder***:
The name of the placeholder this plugin appears.
It is normally a good idea to give the placeholder to the template so you can style
View
2  cms/docs/index.txt
@@ -20,8 +20,10 @@ Contents:
plugins
custom_plugins
i18n
+ sitemap
contribution
+
Indices and tables
==================
View
12 cms/docs/installation.txt
@@ -1,6 +1,10 @@
Installation
============
+This document assumes that you are familiar with python and django.
+
+A more beginner friendly tutorial should be written shortly.
+
Make sure that `cms`, `mptt` and `publisher` folders are on your pythonpath.
They all should come with the distribution.
@@ -89,7 +93,8 @@ near the beginning of the file but after any import statements that it may have:
This allows you to use ``gettext`` in ``settings.py``.
-Add some templates you want to use within Django-cms 2.0 that contain at least one
+Add some templates you want to use within django-cms that contain at least one
+
``{% placeholder %}`` template tag to your ``settings.py``::
CMS_TEMPLATES = (
@@ -157,6 +162,8 @@ Media Files
Be sure to copy the ``cms/media/cms/`` folder into your media directory or make a symbolic
link as appropriate.
+If installed with pip in a virtualenv the media files may be located in the root folder of the the virtualenv.
+
You can use something like `django-appmedia <http://code.google.com/p/django-appmedia/>`_ that handles this for you.
@@ -170,6 +177,7 @@ first before you use it the first time.
If there is a problem with python manage.py migrate:
Create a new ticket on github with your database engine (mysql, postgres), database type (MyIsam, InnoDB), south version
+There are known problems with SQLite and MySQL InnoDB but the Quickfix below should help.
Quick fix:
@@ -190,4 +198,4 @@ If you create a page and you don't see a page in the list view:
If you edit a Page but don't see a "Add Plugin" button and a dropdown-list with plugins:
-- Be sure your CMS_TEMPLATES setting is correct and that the templates specifiet actually exsist. Maybe check that you are not missing a {% placeholder %} templatetag in the template.
+- Be sure your CMS_TEMPLATES setting is correct and that the templates specified actually exist. Maybe check that you are not missing a '{% placeholder %}' templatetag in the template.
Please sign in to comment.
Something went wrong with that request. Please try again.