Injecting fragments of js, css and html in a django-cms plugin
JavaScript Other
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cms_fragments
docs
testfiles
.DS_Store
.gitignore
LICENSE
MANIFEST.in
README.rst
setup.py

README.rst

django-cms-fragments

django-cms-fragments is a plugin for django-cms. With this plugin you can include several fragments of js, css and html in the context of a cms page. Fragments can be added by uploading a file, providing an external url(for js and css), or writing inline code.

The plugin basically adds jss and js to the page, using sekizai tags. It relies on the fact that django-cms requires "js" and "css" blocks to work. The html fragments are rendered within the plugin template.

This package is in an alpha stage, don't use it in production.

I created the project because i didn't want to have to modify my cms installation by adding templates or app_hooks for displaying rich visualizations such as Openlayers Maps or jQplot charts. Another use of the plugin is overriding some css in a particular cms page.

Installation

  • Install via pip:

    pip install django-cms-fragments

  • Add 'cms_fragments' to your INSTALLED_APPS

  • Use 'django.contrib.staticfiles'(by adding it into your INSTALLED_APPS in settings.py), or copy the static subfolder of django-cms-fragments to your static folder

Usage

Add the following code to your admin.py so that you can access the fragments app from your Django Admin panel.

#Lets you add new css, html or js fragments. class FragmentAdmin(admin.ModelAdmin):

fields = ['name', 'fragment_type', 'file', 'direct_url', 'inline_code']

#Lets you add new collection of fragments, maybe a group of css,js and html that sticks together. class FragmentCollectionAdmin(admin.ModelAdmin):

fields = ['name'] #should also have fragments field but giving some error right now, will come back later

admin.site.register(Page, StaffOnlyCMSPageAdmin) admin.site.register(Fragment, FragmentAdmin) admin.site.register(FragmentCollection, FragmentCollectionAdmin)

Fragments

Select add next to fragment title in the admin panel. Then choose the type of the fragment you want to create. (JavaScript, HTML or CSS) Once you create a fragment you can use it in multiple pages by just choosing its name from a drop down menu. You can also create a new fragment while editing a page after adding a fragment plugin clicking the plus button instead of choosing an already created fragment from the drop down.

FragmentsBlocks

Not working yet.

Regions

Not working yet.

Implemented Features

current version:0.0.5

  • FragmentRegions an FragmentBlock
  • FragmentCollection and Fragment models, with admin integration
  • FragmentPlugin and FragmentCollectionPlugin for django-cms
  • css fragments from files, url or inline code
  • js fragments from files, url or inline code
  • html fragments from files or inline code
  • integration with ace editor
  • ordering of elements in a FragmentCollection
  • ...

RoadMap/Planned Features

planned version:0.1.0

  • example fixtures for FragmentCollection and Fragment models
  • live examples
  • drag and drop ordering in admin
  • write docs
  • separate models for css, js and HTML fragments

Release Notes

version 0.0.5:

  • Introduced FragmentRegions

version 0.0.4:

  • Using ace editor instead of editarea
  • Partial documentation at readthedocs.org

Compatibility

The app is being developed for Django >= 1.3.1. I'm not checking compatibility with other Django versions right now.

Credits

The project borrows from the following other codebases:

  • ace editor by ajax.org. The ace license is included in the folder cms_fragments/static/acsjs/LICENSE

Contributors

  • Mauro Bianchi
  • Albert Toledo