{ "info": { "author": "Digital Anvil Ltd", "author_email": "webmaster@digitalanvil.co.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7" ], "description": "djangocms-owl\n=============\n\n**djangocms-owl** is a reuseable plugin for `django-cms`_ that\nimplements the JavaScript carousel library `Owl Carousel`_. Version 1 of\nOwl Carousel is supported.\n\nDependencies\n------------\n\n- Djangocms>=3.0\n- Django>=1.6\n\nInstallation\n------------\n\nInstall Djangocms-owl from Pypi.\n\n.. code:: python\n\n pip install djangocms-owl\n\nAdd Djangocms\\_owl to INSTALLED\\_APPS\n\n.. code:: python\n\n INSTALLED_APPS = (\n ...\n 'djangocms_owl',\n ...\n )\n\n**Owl Carousel** has a dependency on JQuery `Docs`_ that is not\ncurrently included within this package. Add a copy will need adding to a\ntemplate such as the base.html.\n\n.. code:: html\n\n \n\nConfiguration\n-------------\n\nCSS classes can be added to the plugin via a select box by using the\n**DJANGOCMS\\_OWL\\_STYLES** settings tuple.\n\n.. code:: python\n\n DJANGOCMS_OWL_STYLES = (\n ('style1', 'Style 1'),\n ('style2', 'Style 2'),\n )\n\ndjangocms\\_owl/default.html is rendered by default. The user can select\ncustom templates if the following tuple is set as the example below\ndemonstrates.\n\n.. code:: python\n\n DJANGOCMS_OWL_TEMPLATES = (\n ('template1', 'Template 1'),\n ('template2', 'Template 2'),\n )\n\n\nRestrict the plugins available to Owl Carousel\n\n.. code:: python\n\n DJANGOCMS_OWL_CHILD_CLASSES = (\n 'PicturePlugin',\n )\n\nInclude or exclude static files\n\n.. code:: python\n\n DJANGOCMS_OWL_INCLUDE_CSS = True\n DJANGOCMS_OWL_INCLUDE_JS_OWL = True\n DJANGOCMS_OWL_INCLUDE_JS_JQUERY = True\n\nSet the CMS module name in the available plugin list. The default is Generic.\n\n.. code:: python\n\n DJANGOCMS_OWL_MODULE = _('Generic')\n\nTemplates\n---------\n\nbase.html includes all the JavaScript and CSS needed to run the carousel, but it does not render the HTML.\nCustom templates can extend base.html as long as they define a plugin block containing the html and plugin render code as show in the below example.\n\n.. code:: html\n\n {% extends 'djangocms_owl/base.html' %}\n {% load cms_tags %}\n\n {% block plugin %}\n