Skip to content

Commit

Permalink
Misc doc improvements
Browse files Browse the repository at this point in the history
Fixed typo in CHANGELOG.txt
  • Loading branch information
Jonas Obrist committed Oct 29, 2010
1 parent c47c1de commit a6e63f6
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 35 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.txt
Expand Up @@ -33,5 +33,5 @@
- a lot of bugfixes
- the cms now depends on the cms.middleware.media.PlaceholderMediaMiddleware middleware
- templatetags refactored: see cms/docs/templatetags.txt for new signatures.
- placeholder has new option: or and a endbpalceholder templatetag
- placeholder has new option: or and a endpalceholder templatetag

18 changes: 9 additions & 9 deletions docs/installation.rst
Expand Up @@ -73,29 +73,29 @@ Template Context Processors
Templates
---------

You have to define at least one template in `CMS_TEMPLATES` which should
contain at least one `{% placeholder '<name>' %}` tag.
You have to define at least one template in ``CMS_TEMPLATES`` which should
contain at least one ``{% placeholder '<name>' %}`` tag.

urls.py
-------

Include `cms.urls` **at the very end** of your urlpatterns. It **must** be the
Include ``cms.urls`` **at the very end** of your urlpatterns. It **must** be the
last pattern in the list!

Media Files
-----------

Make sure your Django installation finds the cms media files, for this task we
recommend using django-appmedia which will create a symbolic link for you. If
for whatever reason you are unable to use it, copy the folder `cms/media/cms`
for whatever reason you are unable to use it, copy the folder ``cms/media/cms``
into your main media folder.

South
-----

To avoid issues with migrations during the installation process it is currently
recommended to use `python manage.py syncdb --all` and
`python manage.py migrate --fake` for **new** projects. Note that the cms
recommended to use ``python manage.py syncdb --all`` and
``python manage.py migrate --fake`` for **new** projects. Note that the cms
migrations can not be supported on sqlite3.


Expand All @@ -110,6 +110,6 @@ 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 specified
actually exist. 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 and have at least one ``{% placeholder %}``
templatetag in them template.
2 changes: 2 additions & 0 deletions docs/plugins.rst
Expand Up @@ -221,3 +221,5 @@ For installation be sure you have the following in your project's ``INSTALLED_AP
# ...
)

.. warning:: The inherit plugin is currently the only core-plugin which can
**not** be used in non-cms placeholders.
35 changes: 10 additions & 25 deletions docs/sitemap.rst
Expand Up @@ -4,38 +4,23 @@ Sitemap Guide
Sitemap
-------

Sitemap are xml files fetched by google to help your site indexation.
You have to tell google were the sitemap is with the **Webmaster Tools**
Sitemaps are XML files used by Google to index your website by using their
**Webmaster Tools** and telling them the location of your sitemap.

The CMSSitemap will create a sitemap with all the published pages of your cms

Apps
----
Configuration
-------------

Add the following to your project's ``INSTALLED_APPS`` setting::

INSTALLED_APPS = (
...
'django.contrib.sitemaps',
...
)

urls.py
-------

In your main ``urls.py`` add the following import at the top of the file:
from cms.sitemaps import CMSSitemap

Then add the following line at the **start** of the ``urlpatterns`` definition::

urlpatterns = (
url(r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': {'cmspages': CMSSitemap}}),
...
)
Add ``django.contrib.sitemaps`` to your project's ``INSTALLED_APPS`` setting.
Add ``from cms.sitemaps import CMSSitemap`` to the top of your main `urls.py`.
Add ``url(r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': {'cmspages': CMSSitemap}})``
to your urlpatterns.

Django.contrib.sitemaps
-----------------------

More information about ``djangot.contrib.sitemaps`` can be found in the official django documentation `here <http://docs.djangoproject.com/en/dev/ref/contrib/sitemaps/>`_.
More information about ``djangot.contrib.sitemaps`` can be found in the official
`Django documentation <http://docs.djangoproject.com/en/dev/ref/contrib/sitemaps/>`_.


0 comments on commit a6e63f6

Please sign in to comment.