An advanced Plone TinyMCE plugin for handling links to files
Project description
Introduction
This is a plugin for TinyMCE editor for Plone.
It will replace in the less obtrusive way the standard plonelink plugin, providing a version that handle in a different way links to File and Image contents.
Detailed documentation
When the link is not internal or not to a file nothing will change and standard Plone behavior is kept.
When you link a file or an image inside the Plone site you commonly get this XHTML code…:
<a class="internal-link" href="my-pdf">Download the document</a>
Instead you’ll get this…:
<a class="internal-link internal-link-tofile" href="my-pdf" type="application/pdf" title="pdf, 146.2 kB">Download the document</a>
(the same if you have enabled “Link using UIDs”)
The plugin also add a CSS to your Plone site that:
Add the image icon based on file’s mimetype, on the left of the link (if on IE, need IE 7 or better)
After the linked text will be added a text generated with CSS, with the same content you find in the title, put in bracket (need IE 8 or better). IE users with old versions still get’s some additional information thanks to the title HTML attribute.
How a normal page looks like
What you will find inside TinyMCE
Customize format of link to contents
Plone normally doesn’t manage link to file is special ways (it simply generate a link to the base URL of the content).
This plugin will add a new control inside advanced settings:
The “Link format” option, inside advanced settings
Playing with those options can change the format of the generated link, adding a suffix to it.
- Direct link to content (TinyMCE default)
Do not add any suffix.
- Link to content’s preview (default for Image)
A link to a view of the content
- Link to download content (default for File)
Force the download of the file (or image)
Most of the time “Link to download content” is like “Direct link to content”: calling url/to/a/file is like calling url/to/a/file/at_download/file, but without an explicit at_download/file sometimes the target file can be opened by browser plugins (expecially common for images, where url/to/an/image will open the image in the browser).
The “Link to content’ preview” can ne used to create links that are not opening the attachment, but move user to the Plone content.
Extending for custom contents
Let say you are using a new Plone content type, like a Video. You want that TinyMCE links to video contents in a custom way.
What you need is to provide a new adapter for the IFileSuffixes interface:
<adapter
for="your.package.content.IYourVideoType
zope.publisher.interfaces.browser.IHTTPRequest"
provides="collective.tinymceplugins.advfilelinks.interfaces.IFileSuffixes"
factory=".adapters.YourVideoTypeDownloadSuffix"
/>
The provide the Python adapter code:
class YourVideoTypeDownloadSuffix(object):
implements(IFileSuffixes)
def __init__(self, context, request):
self.context = context
self.request = request
self.download_suffix = '/video_download'
self.view_suffix = '/preview_video'
self.default_suffix = 2
You can provide three options:
- download_suffix
Provide the suffix to be added when using “Link to download content” for your content.
Set the value to None and no suffix wil be added or used
- view_suffix
Provide the suffix to be added when using “Link to content’s preview” for your content.
Set the value to None and no suffix wil be added or used
- default_suffix
Provide ad integer value to be used for settings the default combo box option. Use 1 for the first combo option, 2 for the second, and so on.
You can use this feature also for overriding default behavior for File and Image contents.
Dependencies
This product has been tested with:
Plone 3.3.5 and TinyMCE 1.1.12
Plone 4.2.4 and TinyMCE 1.2.15
Credits
Developed with the support of Regione Emilia Romagna; Regione Emilia Romagna supports the PloneGov initiative.
Authors
This product was developed by RedTurtle Technology team.
Thanks to the University of Ferrara for providing CSS rules to be more compatible with additional mimetypes.
Changelog
1.2.0 (2013-02-27)
Restored the default TinyMCE link suffix as default [keul]
Added a new adapter option: default_suffix, to be able to control link type defaul by type [keul]
IFileSuffixes adapters are now multiapdaters (using request also) so customizing types with browserlayer will be possible [keul]
1.1.0 (2012-12-05)
Fixed plugin (removed region-content id) [keul]
Added label for additional info in file popup [keul]
i18n support (and italian translation provided) [keul]
Now uninstall cleanly [keul]
Added link format inside advanced settings [keul]
Now supporting new advanced and pluggable option: “Link format” to handle how the URL to file is created [keul]
Added support for internal link to image content type [keul]
1.0.0 (2012-10-10)
Fixed Plone 4 compatibility icons drawing in popup template [cekk]
0.2.1 (2012-04-20)
Version 0.2.0 was not upgrading properly [keul]
0.2.0 (2012-04-20)
now require z3c.jbot because to fix a bug related to a broken context menu [keul]
no more using a separate link plugin, but we are forced to use the original ones (for the fix above) [keul]
added a product layer [keul]
updated template and code to Product.TinyMCE 1.2 family [keul]
0.1.0 (2011-10-13)
University of Ferrara provided some more CSS rules for better integration with MS Office files [keul]
0.0.1alpha (2010-07-20)
initial release
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
Hashes for collective.tinymceplugins.advfilelinks-1.2.0.zip
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4291b879144b5866a6e86d11bf1fd6a8658b069539a4ad092f799d10873086b7 |
|
| MD5 | 792d94e702b33f682692e607586fe075 |
|
| BLAKE2b-256 | cb0a5d29b21224d0c3f4e38123b3ac487726a39c624a85c24243d3e6a4718b59 |
