tehfink avatar tehfink committed 0fa0b6d

readme updates, version bump

Comments (0)

Files changed (3)

 *.textClipping
 .DS_Store
 project.xml
-*.db
 *.psd
 ~*
 *backup
 Download: http://bitbucket.org/tehfink/cmsplugin-faq/
 
 Requirements:
-- django-cms-2.0: 2.0.0
-- django: 1.1.1
-
-Last tested with:
-- django-cms-2.0: rev b8e65a24b0eb1ea329df003af1bb6c2a0cade5c4
-- django: 1.1.1
+- django-cms-2 >= master 15af8981362ea61699e3d7da03aaac4b40b5fecd
+- django = 1.1.1
 
 Setup
 - make sure requirements are installed and properly working
 - run 'python manage.py syncdb'
 - add plugins to pages
 
+Versioning:
+i'm going to _try_ and track the most recent django-cms release and the current trunk, starting with 2.0.2.
+- branches are named based on django-cms; eg: cms-2.X
+- releases are tagged based on django-cms; eg: cms-2.0.2
+
 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
 - add migrations (south)
 
+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:
+Example Projects:
+- are stripped down, slightly modified versions of django-cms' example project for each relevant version
+- require a virtualenv with the requirements above installed
+- should work out of the box
+- username/password: admin/password
 
+
+Examples (settings.py):
 CMSPLUGIN_FAQENTRY_CSS_CHOICES = (('1', 'featured'),)
 - adds an optional css class to the faq entry in the plugin template
 

cmsplugin_faq/__init__.py

-VERSION = (0, 2, 1, 'beta')
+VERSION = (0, 3, 0, 'beta')
 __version__ = '.'.join(map(str, VERSION))
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.