A behavior for Dexterity-based content types to show previews on hover over hyperlinks in content area.
Project description
Rich Link Preview
Life, the Universe, and Everything
A behavior for Dexterity-based content types to show previews on hover over hyperlinks in content area.
Mostly Harmless
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.behavior.richpreview
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 ‘Rich Link Preview’ and click the ‘Activate’ button.
Usage
TBD.
Development
We use webpack to process static resources on this package. Webpack processes SCSS and JS files, minifies the resulting CSS and JS, and optimizes all images. The final JS file is also a UMD package, which provides compatibility with most popular script loaders.
To contribute, you should start the instance in one shell and start webpack watcher on another with the following command:
$ bin/watch-richpreview
Then go to webpack/app folder and edit SCSS and JS files; Webpack watcher will automatically create the final resources in the right place.
There are also other commands added to handle more complex scenarios. The following command will set the buildout node installation in the system PATH, this way you can use webpack as described on its documentation.
$ bin/env-richpreview
The following command generates JS and CSS without the minify step (it can be used to check the code being generated in a human readable way).
$ bin/debug-richpreview
The following command rebuilds static files and exit (insted of keep watching the changes):
$ bin/build-richpreview
Releasing using zest.releaser
Static resources on this package are generated using webpack and aren’t included in VCS. If you release using zest.releaser you have to upload manually the files to PyPI or you will end with a broken distribution:
run longtest and fullrelease, as usually
answer “no” when asked to upload to PyPI and continue normally
do a checkout to the tag you’re releasing
run bin/build-richpreview to update static files
create the distribution files using python setup.py sdist bdist_wheel as usual
upload the files using twine upload dist/*
In case of errors you will have to create a new release as the PyPI Warehouse doesn’t allow for a filename to be reused.
Changelog
1.0a1 (2018-04-05)
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for collective.behavior.richpreview-1.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d7008508ed74f1e3507aa1fa083ee517921b2f8f83f6ff80e417b9d71eab5a3 |
|
MD5 | a83fab66ec95d9e8cfcde07627e3332c |
|
BLAKE2b-256 | a430ef6c2185906abeeadcd5950c2a2548911c8ba06599d2affa8b462e35a34c |
Hashes for collective.behavior.richpreview-1.0a1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8476d47034c9c680933001060f96a067ca71b2bf8286f0be726a7038eb5edfa8 |
|
MD5 | 58b10448ba3fb1efc794b016e66a8bb0 |
|
BLAKE2b-256 | c620d05a4da8cb32cc257598267f40080914a5aea7fab2d081090ffc3d4886a0 |