DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:mediatooltip

mediatooltip Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin

Last updated on
2018-11-27
Provides
Action
Repository
Source

Tagged with media, mediamanager, tooltip

Installation

For the basic install use the Dokuwiki Extension Manager. This should work without incident. If not, then for a manual install, see Plugin Installation Instructions.

About

This plugin was initially developed to create enhanced tooltips and image filenames for wikis that use images based on photographs. However it has been expanded for use with any media files. The tooltips are based on the jQuery tooltip widget, and their appearance can be controlled by making changes to the style.css file that is included in the plugin directory.

Configuration

The output of the MediaToolTip plugin for photo-based images is controlled by its configuration options. The choices made from the options will alter the file names of the images and depending on the option may affect the information given in the tooltips. Otherwise, all media files will have the jQuery tooltips.

OptionBrief DescriptionChoicesDefault
groups comma separated list of user groups to be used for creating image ids
enable_userid use userid in creating image ids1,01
enable_real use user's real name in creating image ids1,01
date_style choose whether and which date style to use in creating image idsdate_hms
date_hm
date,none
date_hms
time_format time format for creating image idsthe time is taken from the date on which the photograph was takenhour.min.sec
hour-min-sec
hour_min_sec
hour.min.sec

Constructing the Id for Photo-Based Images

If all the defaults are retained, the image id in the Media Manager will have this format:

  • Year-month-day_uploaded_image name_userid.extension

For example, for an image named sunset.jpg with a user named jack, that was photographed on November 12 2018, the file name would be:

  • 2018-11-12_sunset_jack.jpg

If enable_userid is set to false, then the user's real name will be used instead of the userid.

  • 2018-11-12_sunset_jack_smith.jpg

If the user belongs to one of the groups and enable_userid is set to false, the group name will be used. Similarly, if both enable_userid and enable_real are false, the group name will be used. For instance:

  • 2018-11-12_sunset_hikers.jpg

Without a group name and without enabling of userid and the user's real name, the image would be named :

  • 2018-11-12_sunset.jpg

Finally, if no date is found, the image will be named as found on upload:

  • sunset.jpg

Examples

All media files will have tooltips styled by the jQuery tooltip widget. But all images that have photo data attached to them will have tooltips with photo data included. Below are tooltips for two photos, one with a filename that has been changed using the above options, one without filename changes.

filename2016-02-20_18.32.41_04_final_coders.jpgelders.jpg
tooltip
groupcodersnone
original image name04_final.jpgelders.jpg
filenamenon-image media tooltip
eventcheck.tgz

Issues

Please used either github or the forum to report any issues.

plugin/mediatooltip.txt · Last modified: 2018-11-27 13:01 by turnermm