Source

cmsplugin-faq / README.txt

The cms-2.X branch has multiple heads

Full commit
tehfink 5a89ca6 
tehfink bd01601 
tehfink 8471b1c 
tehfink bd01601 
tehfink 5a89ca6 
tehfink bd01601 

tehfink 8471b1c 
tehfink bd01601 
tehfink 8471b1c 
tehfink a818d57 
tehfink bd01601 
tehfink 8471b1c 
tehfink bd01601 
tehfink 8471b1c 
tehfink bd01601 





tehfink 8471b1c 
tehfink bd01601 



tehfink 8471b1c 
tehfink bd01601 



tehfink 8471b1c 
tehfink bd01601 
tehfink a818d57 
tehfink 7c398b7 
tehfink bd01601 
tehfink 8471b1c 
tehfink bd01601 

tehfink 8471b1c 
tehfink 847eeaf 

tehfink bd01601 
tehfink 8471b1c 






tehfink bd01601 

BETA


Name: cmsplugin-faq
Description: duplicate of django-cms2's Text plugin: adds a 'topic' field and link anchors in templates; CMSFaqEntryPlugin creates FAQ entries (questions & answers); CMSFaqListPlugin creates <a> anchor list of FAQ entries, on the same page; CMSFaqEntryLinkPlugin links to specific or random CMSFaqEntries
Download: http://bitbucket.org/tehfink/cmsplugin-faq/


Requirements:
- django-cms-2 = 2.0.2
- django = 1.1.1


Setup
- this release is only compatible with django-cms 2.0.2
- make sure requirements are installed and properly working
- add cmsplugin_faq to python path
- add 'cmsplugin_faq' to INSTALLED_APPS
- run 'python manage.py syncdb'
- add plugins to pages


Optional
- define CMSPLUGIN_FAQLIST_CSS_CHOICES in settings
- copy cmsplugin_faq/templates/plugins/cmsplugin_faq/ to your project directory


Todo:
- allow CMSFaqListPlugin plugin to be on a different page than CMSFaqEntryPlugin
- test with TinyMCE (should work)
- subclass Text plugin when this is possible


NB:
- if you have CMS_MODERATOR enabled, you will see an issue where the FaqEntryLinkPlugin lists FaqEntries twice; the second listing is apparently an empty item. see: http://groups.google.com/group/django-cms/browse_thread/thread/3bc43ed4eb7c5467/2c4af3741bdbaa2d?lnk=gst&q=cms_moderator#2c4af3741bdbaa2d


Examples:

in settings.py:
CMSPLUGIN_FAQENTRY_CSS_CHOICES = (('1', 'featured'),)
- adds an optional css class to the faq entry in the plugin template

in a template:
{% get_latest_faqs 3 as latest_faqs %}
{% for latest in latest_faqs %}
...
{% endfor %}
- returns latest Faq plugins descendant from the current page


Note:
This is not great code, but it works. Please tell me how to make it better!