Skip to main content

Show a disclaimer the first time a user visits a site.

Project description

Disclaimer

Disclaimer

Life, the Universe, and Everything

Show a disclaimer the first time a user visits a site.

Mostly Harmless

http://img.shields.io/pypi/v/collective.disclaimer.svg https://img.shields.io/travis/collective/disclaimer/master.svg https://img.shields.io/coveralls/collective/disclaimer/master.svg

Got an idea? Found a bug? Let us know by opening a support ticket.

Don’t Panic

Installation

To enable this package in a buildout-based installation:

Edit your buildout.cfg and add the following to it:

[buildout]
...
eggs =
    collective.disclaimer

After updating the configuration you need to run ‘’bin/buildout’’, which will take care of updating your system.

Go to the ‘Site Setup’ page in a Plone site and click on the ‘Add-ons’ link.

Check the box next to ‘Disclaimer’ and click the ‘Activate’ button.

Usage

After installing the package, go to the ‘Disclaimer’ configlet on ‘Site Setup’ and enable the feature.

https://raw.githubusercontent.com/collective/disclaimer/master/docs/configlet.png

The Disclaimer control panel configlet.

Now, the first time a user visits the site the disclaimer will be shown at the bottom of the page.

https://raw.githubusercontent.com/collective/disclaimer/master/docs/viewlet.png

The Disclaimer viewlet at work.

Users will see the disclaimer again whenever information in the configlet is updated.

How Does It Work?

This package registers a new viewlet on plone.portalfooter viewlet manager. The viewlet is normally hidden and it will only be shown after checking the user hasn’t seen it yet. The information on last time the viewlet was updated is stored in the user’s browser local storage.

Share and Enjoy

This package would not have been possible without the contribution of the following people:

You can find an updated list of package contributors on GitHub.

Changelog

1.0b1 (2018-12-08)

  • Register the controlpanel for any context. The correct registry is automatically acquired. This way, it’s possible to set different disclaimer texts in a Lineage site with lineage.registry installed. [thet]

  • Add a disclaimer-inner wrapper to allow easier styling, e.g. positioning the viewlet centered on the website and darkening the whole background. [thet]

  • Move styles and scripts into the viewlet, so that they are included when using Diazo and just using the viewlet selector to copy the viewlet into the theme. [thet]

  • Add an “OK” button instead of the close link. When the button is hit, the viewlet is closed and the storage key is set. Previously the storage key was immediately set even without using the “close” link. [thet]

  • Fix translation of default values on configlet (HT @fredvd). [hvelarde]

  • Fix style of hover and visited links inside disclaimer viewlet. [agnogueira]

1.0a1 (2018-05-14)

  • Initial release.

Project details


Download files

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

Source Distribution

collective.disclaimer-1.0b1.tar.gz (90.0 kB view hashes)

Uploaded Source

Built Distribution

collective.disclaimer-1.0b1-py2-none-any.whl (27.7 kB view hashes)

Uploaded Python 2

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