Skip to main content

Adds style plugin to django CMS

Project description

pypi build coverage

django CMS Style is a plugin for django CMS that allows you to create a HTML container containing classes, styles, ids and other attributes definable through the plugins settings.

preview.gif

Contribute to this project and win rewards

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We’re grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies:

python django djangocms

Installation

For a manual install:

  • run pip install djangocms-style

  • add djangocms_style to your INSTALLED_APPS

  • run python manage.py migrate djangocms_style

Configuration

django CMS Style enables you to provide a list of predefined classes to be displayed as first options, the default choices are:

DJANGOCMS_STYLE_CHOICES = ['container', 'content', 'teaser']

You are encouraged to modify that setting to your projects specifications.

This addon provides a default template for all instances. You can provide additional template choices by adding a DJANGOCMS_STYLE_TEMPLATES setting:

DJANGOCMS_STYLE_TEMPLATES = [
    ('feature', _('Feature')),
]

You’ll need to create the feature folder inside templates/djangocms_style/ otherwise you will get a template does not exist error. You can do this by copying the default folder inside that directory and renaming it to feature.

The available tags can also be configured, the default choices are:

DJANGOCMS_STYLE_TAGS = ['div', 'article', 'section', 'header', 'footer',
                        'h1', 'h2', 'h3', 'h4', 'h5', 'h6']

NOTICE:

All tags included in this list should be "paired tags" that require a
closing tag. It does not make sense to attempt to use 'img', 'input',
'meta', or other self-closing tags in this setting.

Also, the developer is advised to choose the tag-types wisely to avoid HTML
validation issues and/or unintentional security vulnerabilities. For
example, the 'script' tag should never be allowed in
``DJANGOCMS_STYLE_TAGS`` (though, we do not prevent this). If you have
an application where you find yourself wishing to do this, please see
djangocms-snippet as an alternative, but note these projects also come
with appropriate security warnings.

After that you can place any number of other plugins inside this style plugin. It will create a div (or other tag-type) with a class that was prior selected around the contained plugins.

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-style-3.1.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

djangocms_style-3.1.0-py3-none-any.whl (127.8 kB view details)

Uploaded Python 3

File details

Details for the file djangocms-style-3.1.0.tar.gz.

File metadata

  • Download URL: djangocms-style-3.1.0.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for djangocms-style-3.1.0.tar.gz
Algorithm Hash digest
SHA256 2f28dfc299615b51b57cdc92ccdd3db1aba706d42d7038335b25f893fabfa1c5
MD5 97de36f16019214bf7bd58c38899587a
BLAKE2b-256 e35ab446e087bd04c702a70ce674cf9dc481a0ede229f34b301e5844d8ea3690

See more details on using hashes here.

Provenance

File details

Details for the file djangocms_style-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_style-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2572ec6eaee73124f588ed007ab563ab668e699f1767c27dc7215d0f9c5741e3
MD5 788717e5ec33d1335e2c3bd4d5424eeb
BLAKE2b-256 73e99786b9c932911eb9ee51ac5fdf751db8bb4205e831378e87a0b093c924c6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page