Go to file
Iacopo Spalletti b2a8f28fe1 Exclude compat library 2014-06-10 08:20:40 +02:00
.tx Add transifex support. Fix #6. 2014-03-29 16:37:52 +01:00
djangocms_blog Toolbar tests 2014-06-10 00:11:48 +02:00
tests Add plugin tests 2014-06-10 08:19:34 +02:00
.coveragerc Exclude compat library 2014-06-10 08:20:40 +02:00
.gitignore Fix setup environment 2014-06-09 00:05:54 +02:00
.travis.yml Boilerplate (still needs working) 2014-01-04 17:07:47 +01:00
AUTHORS.rst Update docs for release 2014-03-06 20:03:07 +01:00
CONTRIBUTING.rst Boilerplate (still needs working) 2014-01-04 17:07:47 +01:00
HISTORY.rst Add basic settings documentation 2014-04-25 19:40:06 +02:00
LICENSE Boilerplate (still needs working) 2014-01-04 17:07:47 +01:00
MANIFEST.in Update manifest, readme and history 2014-02-25 14:47:35 +01:00
Makefile Add support for flake8, wheel 2014-04-19 20:01:08 +02:00
README.rst Update README.rst 2014-04-27 04:25:48 +02:00
requirements-test.txt Fix setup environment 2014-06-09 00:05:54 +02:00
requirements.txt Add support for flake8, wheel 2014-04-19 20:01:08 +02:00
runtests.py Add plugin tests 2014-06-10 08:19:34 +02:00
setup.cfg Add support for flake8, wheel 2014-04-19 20:01:08 +02:00
setup.py Fix tox configuration 2014-06-09 08:38:37 +02:00
tox.ini Fix tox configuration 2014-06-09 08:38:37 +02:00

README.rst

==============
djangocms-blog
==============

.. image:: https://badge.fury.io/py/djangocms-blog.png
    :target: http://badge.fury.io/py/djangocms-blog
    
.. image:: http://img.shields.io/pypi/dm/djangocms-blog.png
        :target: https://crate.io/packages/djangocms-blog?version=latest


A djangoCMS 3 blog application.

Still experimental and untested. You are welcome if you want to try it; if
you encounter any issue, please open an issue.

Documentation
-------------

No doc at the moment, sorry

Quickstart
----------

Install djangocms-blog::

    pip install djangocms-blog

Add ``djangocms_blog`` and its dependencies to INSTALLED_APPS::

    INSTALLED_APPS = [
        ...
        'filer',
        'parler',
        'taggit',
        'django_select2',
        'taggit_autosuggest',
        'djangocms_blog',
        ...
    ]

Then sync and migrate::

    $ python manage.py syncdb
    $ python manage.py migrate

For ``filer`` installationand configuration, please refer to http://django-filer.readthedocs.org

Features
--------

* Placeholder content editing
* Frontend editing using django CMS 3.0 frontend editor
* Multilingual support using django-parler
* Support for Twitter cards, Open Graph and Google+ snippets meta tags
* Optional support for simpler TextField-based content editing

Import from Wordpress
+++++++++++++++++++++

If you want to import content from existing wordpress blog, check
https://pypi.python.org/pypi/the-real-django-wordpress and
this gist https://gist.github.com/yakky/11336204 as a base.


Settings
--------
* BLOG_ENABLE_COMMENTS: Whether to enable comments by default on posts;
  while `djangocms_blog` does not ship any comment system, this flag can be used
  to control the chosen comments framework; (default: True)
* BLOG_USE_PLACEHOLDER: Post content is managed via placeholder; if `False` a
  simple HTMLField is used; (default: True)
* BLOG_IMAGE_THUMBNAIL_SIZE: Size of the main image when shown on the post lists;
  it's a dictionary with `size`, `crop` and `upscale` keys;
  (default: `{'size': '120x120', 'crop': True,'upscale': False}`)
* BLOG_IMAGE_FULL_SIZE: Size of the main image when shown on the post detail;
  it's a dictionary with `size`, `crop` and `upscale` keys;
  (default: `{'size': '640x120', 'crop': True,'upscale': False}`)
* BLOG_PAGINATION: Number of post per page; (defaul: 10)
* BLOG_LATEST_POSTS: Default number of post in the **Latest post** plugin; (defaul: 5)
* BLOG_POSTS_LIST_TRUNCWORDS_COUNT: Default number of words shown for abstract in the post list; (default: 100)

Social media tags settings
++++++++++++++++++++++++++
* BLOG_TYPE: Generic type for the post object; (default: Article)
* BLOG_FB_TYPE: Open Graph type for the post object; (default: Article)
* BLOG_FB_APPID: Facebook Application ID
* BLOG_FB_PROFILE_ID: Facebook profile ID of the post author
* BLOG_FB_PUBLISHER: Facebook URL of the blog publisher
* BLOG_FB_AUTHOR_URL: Facebook profile URL of the post author
* BLOG_FB_AUTHOR: Facebook profile URL of the post author
* BLOG_TWITTER_TYPE: Twitter Card type for the post object; (default: Summary)
* BLOG_TWITTER_SITE: Twitter account of the site
* BLOG_TWITTER_AUTHOR: Twitter account of the post author
* BLOG_GPLUS_TYPE: Google+ Snippet type for the post object; (default: Blog)
* BLOG_GPLUS_AUTHOR: Google+ account of the post author

.. image:: https://d2weczhvl823v0.cloudfront.net/nephila/djangocms-blog/trend.png
   :alt: Bitdeli badge
   :target: https://bitdeli.com/free