Django cmsplugin-faq cmsplugin_faq
FAQ plugin based on CKEditor for the Django-CMS project
Status: Beta
Brought to you by:
tehfink
Menu
▾
▴
Tree [967e58] default tip / History
| File | Date | Author | Commit |
|---|---|---|---|
| cmsplugin_faq | 2023-11-01 |
tehfink
|
[d064c5] updates for djangocms-text-ckeditor 5.1.4 |
| .hgignore | 2018-04-08 |
tehfink
|
[e096e4] starting branch cms-3.5 |
| .hgtags | 2023-11-01 |
tehfink
|
[2b6155] Added tag 0.9.7 for changeset d7bbbbc27da3 |
| AUTHORS.rst | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
| HISTORY.rst | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
| LICENSE | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
| MANIFEST.in | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
| README.rst | 2023-11-01 |
tehfink
|
[967e58] django version |
| setup.cfg | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
| setup.py | 2023-11-01 |
tehfink
|
[d7bbbb] updated to: django 4.2, django-cms 3.11, python... |
Read Me
cmsplugin-faq
Description
- FAQ plugin based on CKEditor for the Django-CMS project.
- Subclasses django-cms's Text plugin (djangocms_text_ckeditor): supports django-cms text plugins, a 'topic' field, 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, latest, or random CMSFAQEntries
Requirements
- djangocms_text_ckeditor >= 5.1.4
- Django-cms >= 3.11
- Django >= 4.2
- Python >= 3.9
Setup
- Make sure requirements are installed and properly working
- Add cmsplugin_faq to python path
- e.g.: pip install hg+http://hg.code.sf.net/p/django-cmsplugin-faq/cmsplugin_faq#egg=cmsplugin-faq
- Add 'cmsplugin_faq' to Django project's INSTALLED_APPS
- Run migrations
- Add plugins to Django CMS pages
Optional
- Define CMSPLUGIN_FAQENTRY_CSS, CMSPLUGIN_FAQLIST_CSS, CMSPLUGIN_FAQENTRYLINK_CSS in your project's settings
- Copy cmsplugin_faq/templates/cms/plugins/cmsplugin_faq/ to your project directory
Examples (settings.py)
CMSPLUGIN_FAQENTRY_CSS = ((1, 'featured'),) - Adds an optional css class to the faq entry in the plugin template
Versioning
Trying to track the most recent django-cms, djangocms_text_ckeditor & django-cms LTS releases (when I get to it).
Todo
- django-parler support
- Namespacing of settings (in a dict?)
Note
This is not great code, but it works. Please tell me how to make it better!
