djangocms_blog/README.rst

117 lines
4.5 KiB
ReStructuredText
Raw Normal View History

2014-02-25 13:46:50 +00:00
==============
2014-01-05 09:34:10 +00:00
djangocms-blog
2014-02-25 13:46:50 +00:00
==============
2014-01-05 09:34:10 +00:00
2015-10-17 13:55:54 +00:00
.. image:: https://img.shields.io/pypi/v/djangocms-blog.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-blog
:alt: Latest PyPI version
2014-08-29 03:59:12 +00:00
2015-10-17 13:55:54 +00:00
.. image:: https://img.shields.io/pypi/dm/djangocms-blog.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-blog
:alt: Monthly downloads
2015-02-08 21:46:28 +00:00
2015-10-17 13:55:54 +00:00
.. image:: https://img.shields.io/pypi/pyversions/djangocms-blog.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-blog
:alt: Python versions
2014-06-11 11:05:41 +00:00
2015-10-17 13:55:54 +00:00
.. image:: https://img.shields.io/travis/nephila/djangocms-blog.svg?style=flat-square
:target: https://travis-ci.org/nephila/djangocms-blog
:alt: Latest Travis CI build status
2015-10-17 13:55:54 +00:00
.. image:: https://img.shields.io/coveralls/nephila/djangocms-blog/master.svg?style=flat-square
:target: https://coveralls.io/r/nephila/djangocms-blog?branch=master
:alt: Test coverage
2014-01-05 09:34:10 +00:00
2015-10-18 16:02:06 +00:00
.. image:: https://img.shields.io/codecov/c/github/nephila/djangocms-blog/develop.svg?style=flat-square
2015-10-17 13:55:54 +00:00
:target: https://codecov.io/github/nephila/djangocms-blog
:alt: Test coverage
.. image:: https://codeclimate.com/github/nephila/djangocms-blog/badges/gpa.svg?style=flat-square
2015-09-01 08:35:54 +00:00
:target: https://codeclimate.com/github/nephila/djangocms-blog
:alt: Code Climate
2016-02-02 10:36:08 +00:00
django CMS blog application - Support for multilingual posts, placeholders, social network meta tags and configurable apphooks.
2014-02-25 13:46:50 +00:00
Supported Django versions:
2015-07-21 06:27:49 +00:00
* Django 1.8
2016-05-03 06:37:18 +00:00
* Django 1.9
Supported django CMS versions:
2016-06-05 16:35:06 +00:00
* django CMS 3.2+
.. warning:: Version 0.8 will be the last one supporting Python 2.6, Python 3.3,
2016-05-29 16:53:20 +00:00
Django<1.8 and django CMS<3.2.
.. warning:: Starting from version 0.8, date_published is not set anymore
when creating a post but rather when publishing.
This does not change the overall behavior, but be warned if you
expect it to be not null in custom code.
2015-08-14 17:22:00 +00:00
.. warning:: Version 0.6 changes the field of LatestPostsPlugin.tags field.
A datamigration is in place to migrate the data, but check that
works ok for your project before upgrading, as this might delete
some relevant data.
2016-01-18 19:08:25 +00:00
Some plugins have a broken tag management prior to 0.6, in case
you have issues with tags, upgrade to latest version to have it fixed.
2014-12-05 14:52:37 +00:00
2016-06-25 15:32:45 +00:00
Upgrading cmsplugin-filer from 1.0 to 1.1
-----------------------------------------
Due to changes in cmsplugin-filer/filer which moved ``ThumbnailOption`` model from the
former to the latter, ``djangocms-blog`` must be migrated as well.
Migrating cmsplugin-filer to 1.1 and djangocms-blog up to 0.8.4
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
If you have djangocms-blog up to 0.8.4 (included) installed or you are upgrading from a previous
djangocms-blog version together with cmsplugin-filer upgrade, you can just apply the migrations::
pip install cmsplugin-filer==1.1.1 django-filer==1.2.2 djangocms-blog==0.8.4
python manage.py migrate
Migrating cmsplugin-filer to 1.1 and djangocms-blog 0.8.5+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
If you already a djangocms-blog 0.8.5+ or above, you have to de-apply some blog migrations when
doing the upgrade::
python manage.py migrate djangocms_blog 0017 ## reverse for these migration is a noop
pip install cmsplugin-filer==1.1.1 django-filer==1.2.2
python manage.py migrate
.. note:: de-apply migration **before** upgrading cmsplugin-filer. If running before upgrade, the
backward migration won't alter anything on the database, and it will just allow the code
to migrate ``ThumbnailOption`` from cmsplugin-filer to filer
2015-10-18 08:49:45 +00:00
Features
--------
* Placeholder content editing
2016-03-01 08:48:06 +00:00
* Frontend editing using django CMS 3.x frontend editor
2015-10-18 08:49:45 +00:00
* Multilingual support using django-parler
* Support for Twitter cards, Open Graph and Google+ snippets meta tags
* Optional support for simpler TextField-based content editing
* Multisite support (posts can be visible in one or more Django sites on the
same project)
* Per-Apphook configuration
2015-10-31 01:06:57 +00:00
* Configurable permalinks
* Configurable django CMS menu support
2015-10-18 08:49:45 +00:00
* Per-Apphook templates set
* Auto Apphook setup
2015-10-31 01:06:57 +00:00
* Django sitemap framework support
2015-10-25 19:10:25 +00:00
* Support for django CMS 3.2+ Wizard
* Haystack index support
2014-12-05 14:52:37 +00:00
2016-06-05 22:05:14 +00:00
Documentation
-------------
2014-01-05 09:34:10 +00:00
Check documentation at https://djangocms-blog.readthedocs.io/en/latest/
2014-01-06 09:37:55 +00:00
2015-03-02 06:08:59 +00:00
Known djangocms-blog websites
+++++++++++++++++++++++++++++
2016-03-04 07:26:20 +00:00
See DjangoPackages for an updated list https://www.djangopackages.com/packages/p/djangocms-blog/