Fix documentation [ci skip]
This commit is contained in:
parent
bb17b71158
commit
bf0563ee05
3 changed files with 65 additions and 3 deletions
|
@ -3,6 +3,12 @@
|
||||||
History
|
History
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
0.6.1 (2015-10-31)
|
||||||
|
++++++++++++++++++
|
||||||
|
|
||||||
|
* Improve toolbar: add all languages for each post
|
||||||
|
* Improve toolbar: add per-apphook configurable changefreq, priority
|
||||||
|
|
||||||
0.6.0 (2015-10-30)
|
0.6.0 (2015-10-30)
|
||||||
++++++++++++++++++
|
++++++++++++++++++
|
||||||
|
|
||||||
|
|
61
README.rst
61
README.rst
|
@ -63,8 +63,11 @@ Features
|
||||||
* Multisite support (posts can be visible in one or more Django sites on the
|
* Multisite support (posts can be visible in one or more Django sites on the
|
||||||
same project)
|
same project)
|
||||||
* Per-Apphook configuration
|
* Per-Apphook configuration
|
||||||
|
* Configurable permalinks
|
||||||
|
* Configurable django CMS menu support
|
||||||
* Per-Apphook templates set
|
* Per-Apphook templates set
|
||||||
* Auto Apphook setup
|
* Auto Apphook setup
|
||||||
|
* Django sitemap framework support
|
||||||
* Support for django CMS 3.2+ Wizard
|
* Support for django CMS 3.2+ Wizard
|
||||||
* Haystack index support
|
* Haystack index support
|
||||||
|
|
||||||
|
@ -206,6 +209,16 @@ like the following in the project settings::
|
||||||
|
|
||||||
And change ``post/`` with the desired prefix.
|
And change ``post/`` with the desired prefix.
|
||||||
|
|
||||||
|
Menu
|
||||||
|
++++
|
||||||
|
|
||||||
|
``djangocms_blog`` provides support for django CMS menu framework.
|
||||||
|
|
||||||
|
By default all the categories and posts are added to the menu, in a hierarcical structure.
|
||||||
|
|
||||||
|
Is it possibile to configure per Apphook, whether the menu includes post and categories
|
||||||
|
(the default), only categorie, only posts or no item.
|
||||||
|
|
||||||
Templates
|
Templates
|
||||||
+++++++++
|
+++++++++
|
||||||
|
|
||||||
|
@ -249,6 +262,43 @@ The auto setup is execute once for each server start but it will skip any
|
||||||
action if a ``BlogConfig`` instance is found.
|
action if a ``BlogConfig`` instance is found.
|
||||||
|
|
||||||
|
|
||||||
|
Sitemap
|
||||||
|
+++++++
|
||||||
|
|
||||||
|
``djangocms_blog`` provides a sitemap for improved SEO indexing.
|
||||||
|
Sitemap returns all the published posts in all the languages each post is available.
|
||||||
|
|
||||||
|
The changefreq and priority is configurable per-apphook (see ``BLOG_SITEMAP_*`` in `settings`_).
|
||||||
|
|
||||||
|
To add the blog Sitemap, add the following code to the project ``urls.py``::
|
||||||
|
|
||||||
|
|
||||||
|
from cms.sitemaps import CMSSitemap
|
||||||
|
from djangocms_blog.sitemaps import BlogSitemap
|
||||||
|
|
||||||
|
|
||||||
|
urlpatterns = patterns(
|
||||||
|
'',
|
||||||
|
...
|
||||||
|
url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap',
|
||||||
|
{'sitemaps': {
|
||||||
|
'cmspages': CMSSitemap, 'blog': BlogSitemap,
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
django CMS 3.2+ Wizard
|
||||||
|
++++++++++++++++++++++
|
||||||
|
|
||||||
|
django CMS 3.2+ provides a content creation wizard that allows to quickly created supported
|
||||||
|
content types, such as blog posts.
|
||||||
|
|
||||||
|
For each configured Apphook, a content type is added to the wizard.
|
||||||
|
|
||||||
|
|
||||||
|
.. _settings:
|
||||||
|
|
||||||
Global Settings
|
Global Settings
|
||||||
---------------
|
---------------
|
||||||
* BLOG_IMAGE_THUMBNAIL_SIZE: Size of the main image when shown on the post
|
* BLOG_IMAGE_THUMBNAIL_SIZE: Size of the main image when shown on the post
|
||||||
|
@ -292,8 +342,6 @@ Global Settings
|
||||||
* BLOG_USE_PLACEHOLDER: Post content is managed via placeholder;
|
* BLOG_USE_PLACEHOLDER: Post content is managed via placeholder;
|
||||||
if ``False`` a simple HTMLField is used; (default: ``True``)
|
if ``False`` a simple HTMLField is used; (default: ``True``)
|
||||||
* BLOG_MULTISITE: Add support for multisite setup; (default: ``True``)
|
* BLOG_MULTISITE: Add support for multisite setup; (default: ``True``)
|
||||||
* BLOG_MENU_TYPE: Structure of the Blog menu;
|
|
||||||
(default: ``Posts and Categories``)
|
|
||||||
* BLOG_AUTHOR_DEFAULT: Use a default if not specified; if set to ``True`` the
|
* BLOG_AUTHOR_DEFAULT: Use a default if not specified; if set to ``True`` the
|
||||||
current user is set as the default author, if set to ``False`` no default
|
current user is set as the default author, if set to ``False`` no default
|
||||||
author is set, if set to a string the user with the provided username is
|
author is set, if set to a string the user with the provided username is
|
||||||
|
@ -316,6 +364,15 @@ Global Settings
|
||||||
**hourly**, **daily**, **weekly**, **monthly**, **yearly**, **never**)
|
**hourly**, **daily**, **weekly**, **monthly**, **yearly**, **never**)
|
||||||
* BLOG_SITEMAP_CHANGEFREQ_DEFAULT: Default changefreq for sitemap items; (default: ``monthly``)
|
* BLOG_SITEMAP_CHANGEFREQ_DEFAULT: Default changefreq for sitemap items; (default: ``monthly``)
|
||||||
|
|
||||||
|
Read-only settings
|
||||||
|
++++++++++++++++++
|
||||||
|
|
||||||
|
* BLOG_MENU_TYPES: Available structures of the Blog menu; (default list **Posts and Categories**,
|
||||||
|
**Categories only**, **Posts only**, **None**)
|
||||||
|
* BLOG_MENU_TYPE: Structure of the Blog menu;
|
||||||
|
(default: ``Posts and Categories``)
|
||||||
|
|
||||||
|
|
||||||
Per-Apphook settings
|
Per-Apphook settings
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
|
|
@ -57,7 +57,6 @@ def get_setting(name):
|
||||||
'BLOG_POSTS_LIST_TRUNCWORDS_COUNT': getattr(
|
'BLOG_POSTS_LIST_TRUNCWORDS_COUNT': getattr(
|
||||||
settings, 'BLOG_POSTS_LIST_TRUNCWORDS_COUNT', 100
|
settings, 'BLOG_POSTS_LIST_TRUNCWORDS_COUNT', 100
|
||||||
),
|
),
|
||||||
'BLOG_MENU_TYPE': MENU_TYPES,
|
|
||||||
'BLOG_MENU_TYPES': MENU_TYPES,
|
'BLOG_MENU_TYPES': MENU_TYPES,
|
||||||
'BLOG_TYPE': getattr(settings, 'BLOG_TYPE', 'Article'),
|
'BLOG_TYPE': getattr(settings, 'BLOG_TYPE', 'Article'),
|
||||||
'BLOG_TYPES': meta_settings.OBJECT_TYPES,
|
'BLOG_TYPES': meta_settings.OBJECT_TYPES,
|
||||||
|
|
Loading…
Add table
Reference in a new issue