This is an old revision of the document!
Table of Contents
mediatooltip Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" unknown
- 2022-07-31 "Igor" unknown
- 2020-07-29 "Hogfather" yes
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.
Expanded tooltip support
The latest upgrade includes expanded support for tooltips. It provides for inclusion of up to eight fields in the tooltip data and display:
- Camera make and type, assuming one was used
- the File in which the image is stored on the server
- the Exposure data, if
Camera
is selected - the Date that the image or photo was created
- the name of the Artist or potographer who made the image/photo
- Caption , if provided
- Copyright info if available;
- the Size of the image in pixels and size of the file on the server;
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.
Option | Brief Description | Choices | Default | |
---|---|---|---|---|
fields | Checkbox for selecting one or more fields for inclusion in tooltips | |||
groups | comma separated list of user groups to be used for creating image ids | |||
enable_userid | use userid in creating image ids | 1,0 | 1 | |
enable_real | use user's real name in creating image ids | 1,0 | 1 | |
date_style | choose whether and which date style to use in creating image ids | date_hms date_hm date,none | date_hms | |
time_format | time format for creating image ids | the time is taken from the date on which the photograph was taken | hour.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.
Issues
Please used either github or the forum to report any issues.
- Synched master with layout (2021-04-16 00:10)
- removewd debugging (2021-04-15 20:05)
- update version (2021-04-15 19:46)
- Place either copyright or caption as below image with caption taking … (2021-04-15 19:40)
- Adds localization (2021-04-13 18:08)
- Fixed integer recognition in jquery.css()by using parseInt when updat… (2021-04-12 19:54)
- updates style.css with overflow-wrap (2021-04-12 18:43)
- updates version (2021-04-12 16:39)