Source

cmsplugin-news / README.txt

Full commit
ALPHA

Name: cmsplugin-news
Description: A news plugin for django-cms
Download: http://bitbucket.org/MrOxiMoron/cmsplugin-news/

Requirements:
- django-cms-2.0: rev 2b59edde3cf1c140edfb14b544f2fbcbd56073f8
- django: 1.1.1
+ requirements for django-cms-2.0

Last tested with:
- django-cms-2.0: rev 276bae54e2184187db7e71f2aab54121db7c729d
- django: 1.1.1

Setup
- make sure requirements are installed and properly working
- add cmsplugin_news to python path
- add 'cmsplugin_news' to INSTALLED_APPS
- run 'python manage.py syncdb'
- Add the cmsplugin_news.urls to the CMS_APPLICATIONS_URLS setting 
- Add the cmsplugin_news.navigation.get_nodes to the CMS_NAVIGATION_EXTENDERS setting
- Create a page and link the application and navigation to it. (Restart of the server required due to caching!)
- Create the propper templates for your site, the ones included with the app are VERY basic

Todo and Tomaybes:
- Add more tests
- add to cms_plugins.py for plugins
 - month view with days that link to archive_day view
- add setup.py for easyinstall / pip
- Allow comments on news (add option to the news model for it)
- Add migrations
- Optimize the navigation code, it works but there is probably a better way to do it.
- Add RSS feed
- Add optional author field
- Add optional end date to hide news again
- Add Tags
- Add translations (I can do the dutch one)
- Ideas other people come up with :D

Examples:

CMS_APPLICATIONS_URLS = (
    ('cmsplugin_news.urls', 'News'),
)
CMS_NAVIGATION_EXTENDERS = (
    ('cmsplugin_news.navigation.get_nodes','News navigation'),
)


Suggestion:
To avoid confusion add a "application" template to the CMS which is like other templates but without any placeholders.
That way users won't get tempted to fill the placeholders and then complain they don't show up ;-)