DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:autotooltip

Auto-Tooltip 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 Manually create tooltips, or generate them off of the title and abstract of a wikilink

Last updated on
2018-12-28
Provides
Syntax, Helper, Render
Repository
Source

Similar to tooltip

Tagged with abstract, tooltip

This syntax/helper plugin allows you to construct tooltips for text on the page, or to automatically generate tooltips based on a wikilink's title and abstract. If you enable the renderer plugin, it can even add a tooltip to every internal wikilink on your site!

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples/Usage

Manual tooltips

<autott>
  <content>This is the linked text on the page.</content>
  <tip>The body of the tooltip.</tip>
  <title>An optional title for the tooltip</title>
</autott>

This creates a simple tooltip for text on the page.

Customizing a tooltip

<autott style1 style2>...</autott>

There is an admin setting to change the default styling of all tooltips. If you want to override that for a single tooltip, you can specify styles in the tooltip definition. Available classes are:

  • default: A semi-transparent black tooltip with rounded border.
  • blue: Same as default, but blue.
  • plain: A white tooltip with black text and a black border.
  • small: Smaller font size. This can be combined with any of the above styles.

You can add additional styles in your CSS. Class names are of the form plugin-autotooltip__MYNAME. For instance, to create a tooltip with an image for a background and white text, add this CSS:

.plugin-autotooltip__picture {
  background: url(/path/to/image.jpg);
  color: #fff;
}

and then create your tooltip like this:

<autott picture>...</autott>

Generating a tooltip

<autott>wiki:syntax</autott>

This will generate a link to wiki:syntax, using the page's title as the link text. The tooltip will include the page's title and abstract.

<autott>wiki:syntax|Custom Title</autott>

Same as above, but the link text will be “Custom Title.”

Using the syntax above, you can add tooltips to any wikilink, but what if you want a tooltip on every wikilink?

To enable this feature, go to AdminConfigurationAdvancedrenderer_xhtml, and select “Auto-Tooltip.” Unfortunately, DokuWiki only allows you to use one renderer plugin at a time, so this won't work with any other renderer plugin. If you can't use this renderer plugin, consider Auto-link 4, which can add tooltips to links that it generates.

You won't see tooltips on self-referential links. In other words, a link to wiki:whatever on wiki:whatever will not have a tooltip.

Configuration

  • style: A space-delimited set of default classes. This can include the built-in styles, or any CSS class you create that starts with "plugin-autotooltip__."
  • delay: The time in miliseconds to wait before showing a tooltip.
  • linkall_inclusions: When using the renderer plugin to add tooltips to all links, this is a regular expression for pages or namespaces to include. For example, “^wiki:|^stuff:” inludes only links from the wiki and stuff namespaces. Leave blank to include all pages.
  • linkall_exclusions: A regular expression for pages or namespaces to exclude. When combined with linkall_inclusions, this means “Include these pages, except those pages.” This works well with Include and similar plugins, allowing you to, for example, exclude tooltips on all sidebars, but keep them on the page.

Helper Plugin

The helper exposes these methods:

forText

Create a manual tooltip.

$tooltip->forText($content, $tooltip, $title='', $preTitle='', $classes='', $textStyle='');
  • $content: The on-page text.
  • $tooltip: The tooltip content. Newlines will be rendered as line breaks.
  • $title: The title inside the tooltip.
  • $preTitle: Text to display before the title. Newlines will be rendered as line breaks.
  • $classes: CSS classes to add to this tooltip. "dokuwiki-plugin__" will be prepended to each class.
  • $textStyle - CSS styles for the linked content.

Create a wikilink.

$tooltip->forWikilink($id, $content=null, $classes='', $linkStyle='');
  • $id - A page id.
  • $content - The on-page content. Newlines will be rendered as line breaks. Omit to use the page's title.
  • $preTitle - Text to display before the title in the tooltip. Newlines will be rendered as line breaks.
  • $classes - CSS classes to add to this tooltip. "dokuwiki-plugin__" will be prepended to each class.
  • $linkStyle - Style attribute for the link.

Compatibility

  • description: If you add a description to a page using this plugin, tooltips will show the description, rather than DokuWiki's generated abstract.

Development

Change Log

Discussion

plugin/autotooltip.txt · Last modified: 2018-12-28 17:19 by zioth