DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:tooltip

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:tooltip [2010-09-01 23:07] – updated download&demo ryan.chappelleplugin:tooltip [2020-07-27 16:42] (current) – +donationurl, +update author info ryan-chappelle
Line 1: Line 1:
-====== tooltip plugin ======+====== tooltip Plugin ======
  
 ---- plugin ---- ---- plugin ----
-description: This plugin lets you mark some text with a tooltip.+description: This plugin lets you mark some text with a tooltip
 author     : Luis Machuca Bezzaza author     : Luis Machuca Bezzaza
-email      : luis.machuca@gulix.cl+email      : lambalicious [at] tuta [dot] io
 type       : syntax type       : syntax
 lastupdate : 2009-10-04 lastupdate : 2009-10-04
-compatible : +compatible : Hrun, Detritus, Binky, Weatherwax, Adora Belle, Angua, Rincewind
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : +similar    : autotooltip
 tags       : annotations, tooltip tags       : annotations, tooltip
  
 downloadurl: http://ryan.gulix.cl/dw/_media/desarrollo/dokuwiki/dw-plugin-tooltip-latest.zip downloadurl: http://ryan.gulix.cl/dw/_media/desarrollo/dokuwiki/dw-plugin-tooltip-latest.zip
 +donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=T44AQDXJQJTJQ&source=url
  
 ---- ----
Line 21: Line 22:
 Welcome to the **Tooltip Plugin page**. This plugin does essentially what the name suggests: marks some text with a visual aid that shows in mouse-over, what's called a [[wp>tooltip]]. No JavaScript nor any other kind of scripting involved((beyond the PHP parser for the plugin itself)). It's all CSS, baby! Welcome to the **Tooltip Plugin page**. This plugin does essentially what the name suggests: marks some text with a visual aid that shows in mouse-over, what's called a [[wp>tooltip]]. No JavaScript nor any other kind of scripting involved((beyond the PHP parser for the plugin itself)). It's all CSS, baby!
  
-I'm [[http://forum.dokuwiki.org/user/2446|Luis Machuca]], a DW __fan__ who's collaborated with some templates and plugins before, making suggestions and the like. This is my second attempt at an actual, more direct, collaboration in the form of a special markup plugin.+I'm [[user>ryan.chappelle|Luis Machuca]], a DW __fan__ who's collaborated with some templates and plugins before, making suggestions and the like. This is my second attempt at an actual, more direct, collaboration in the form of a special markup plugin.
  
 Feel free to use and comment (see =>[[#Discussion]]). Feel free to use and comment (see =>[[#Discussion]]).
Line 48: Line 49:
 | ''marked_text''   | any text     | The text that is marked with the tooltip information.  | | ''marked_text''   | any text     | The text that is marked with the tooltip information.  |
 | ''word''          | single word  | A __single word__ that is marked with the tooltip information.  | | ''word''          | single word  | A __single word__ that is marked with the tooltip information.  |
-| ''tooltip_text''  | any text     | The text that is contained in the tooltip.  Som markup such as **bolding** is enabled, as well as [[this>|links]].  |+| ''tooltip_text''  | any text     | The text that is contained in the tooltip.  The text contained in the tooltip also supports DokuWiki syntax - such as **bolding**, //italics//, __underline__, strike through, superscript, subscript, smileys, and special characters, as well as internal and external links.  |
  
 ===== Installation and Usage ===== ===== Installation and Usage =====
 +
  
 ==== How to Install ==== ==== How to Install ====
  
-Use the download link above and feed it to your Plugin Manager. +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- +
-Shall the link above fail, you can [[#Demo|try directly from the Demo Page]] and search the list of available files for the plugin. +
- +
-No Plugin Manager? Download the source code and unzip into the ''plugins'' directory of your DokuWiki installation. A folder named ''tooltip'' shall be created containing the source code and style sheets+
  
 ==== Demo ==== ==== Demo ====
Line 67: Line 65:
 Note language is **Spanish** but online translators shall do a good job with it. Note language is **Spanish** but online translators shall do a good job with it.
  
-^  {{http://ryan.gulix.cl/archivos/dokuwiki/scr-plugin-tooltip-01.png?300&nolink}}  ^  {{http://ryan.gulix.cl/archivos/dokuwiki/scr-plugin-tooltip-02.png?300&nolink}} +^  {{http://ryan.gulix.cl/archivos/dokuwiki/scr-plugin-tooltip-01.png?300&nolink}} 
-|  The effects of the ''tooltip'' plugin (normal form) upon mouse-over. |   The effects of the ''tooltip'' plugin (shorthand form) upon mouse-over. |+|  The effects of the ''tooltip'' plugin upon mouse-over. |
  
 ==== How to Use ==== ==== How to Use ====
Line 167: Line 165:
   - another underline syntax is already applied to the marked text (by either the DokuWiki ''%%__text__%%'' syntax, or applied CSS). In this case line height may be altered for both the marked text and the tooltip box, whose contents may also overflow.   - another underline syntax is already applied to the marked text (by either the DokuWiki ''%%__text__%%'' syntax, or applied CSS). In this case line height may be altered for both the marked text and the tooltip box, whose contents may also overflow.
  
-Any browser not indicated above is not officially supportedbut as long as it supports CSS 2 __correctly__((yes, that means CORRECTLY, as in "not the Internet Explorer way")), presentation should be consistent. Even a textmode browser such as ''links'' should degrade gracefully and allow to either display the entire tooltip alongside the text, or display nothing at all.+Any other browser that correctly implements the CSS2 spec will display properly when using this plugin. Howeverfor non-conforming browsers as well as text-mode rendering a graceful degradation should be observed that allows clients to see either both the text and tooltip, or nothing at all.
  
-If the DokuWiki installation has been set up to deliver content via the [[doku>plugin:text|text renderer]], tooltip content will be visible and clearly delimited from the surrounding text.+If the DokuWiki installation has been set up to deliver content via the [[plugin:text|text renderer]], tooltip content will be visible and clearly delimited from the surrounding text.
  
 ==== Localization ==== ==== Localization ====
Line 199: Line 197:
 ==== Rendering Information ==== ==== Rendering Information ====
  
-The plugin has been tested to be compatible with the following [[doku>/plugins?plugintype=8|renderer plugins]]:+The plugin has been tested to be compatible with the following [[http://www.dokuwiki.org/plugins?plugintype=8|renderer plugins]]:
   * ''no-details-XHTML'' (the one I use)   * ''no-details-XHTML'' (the one I use)
   * ''text'' (basic support, usable but not yet completed)   * ''text'' (basic support, usable but not yet completed)
Line 274: Line 272:
 ==== Author Developments ==== ==== Author Developments ====
  
-^ Other Plugins by\\ Luis Machuca:   | [[doku>plugin:progrecss]]\\ [[doku>plugin:clock]]\\ [[doku>plugin:divalign2]]\\ [[doku>plugin:hide]]\\ [[doku>plugin:gil]]   |+^ Other Plugins by\\ Luis Machuca:   | [[plugin:progrecss]]\\ [[plugin:clock]]\\ [[plugin:divalign2]]\\ [[plugin:hide]]\\ [[plugin:gil]]   |
  
 ---- datarelated ---- ---- datarelated ----
Line 324: Line 322:
 21/07/2010 21/07/2010
 >University servers went through some maintenance. Should be solved by... now.  --- //[[luis.machuca@gulix.cl|Luis]] 2010/07/22 23:37// >University servers went through some maintenance. Should be solved by... now.  --- //[[luis.machuca@gulix.cl|Luis]] 2010/07/22 23:37//
 +
 +Q4: Would it be possible to choose the width of the box? When a text is 20 short words long, the box is vertical, and I would prefer to have it horizontal, to improve its lisibility.
 +Thanks a lot for this nice plugin.
 +**[[emache47@gmail.com|Michel H.]]**
 +>In theory, it should be possible by passing extra argument. However I'd have to solve some parsing issues first. I'll examine this issue.
 +In the meantime, if required you can overwrite the CSS for the plugin via ''$DOKU_CONF/userstyle.css'', but this will affect //all// invocations of the syntax.  --- [[user>ryan.chappelle|Luis Machuca Bezzaza]] //2012/01/20 16:32//
 +
 +Q5: Would it be possible to remove the adding space after every "!word" mark, as it makes it complicated to add a footnote style tooltip in between a word and a dot? (Ends up looking like this: "..some text[TAG] . More text..." Thanks a lot! This plugin has made marvels for me.
plugin/tooltip.1283375260.txt.gz · Last modified: 2010-09-01 23:07 by ryan.chappelle

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki