====== Highlight Plugin ======

---- plugin ----
description: Enables a simple mark-up syntax for highlighting text in various colors
author     : Joseph Nahmias
email      : joe@nahmias.net
type       : syntax
lastupdate : 2013-10-24
compatible : Ponder Stibbons, Binky, Weatherwax, Frusterick Manners, Greebo, !Hogfather
depends    : 
conflicts  : 
similar    : changemarks, emphasis, fontcolor, wrap, color
tags       : marking, highlight, !discontinued

downloadurl: https://github.com/munduch/dokuwiki-highlight/archive/master.zip
bugtracker:  https://github.com/munduch/dokuwiki-highlight/issues
sourcerepo:  https://github.com/munduch/dokuwiki-highlight/

screenshot_img: :plugin:highlight_plugin.png
----
FIXME: REPOSITORY NO LONGER EXIST


===== Installation =====

Please use the [[plugin:extension|extension manager]] to install the plugin.

//Optional//  Add additional colors to your [[devel:javascript|conf/userscript.js]] file (see [[#additional_colors|below]] for more details)

===== Usage =====

You could type or input via the toolbar button {{https://raw.githubusercontent.com/munduch/dokuwiki-highlight/master/images/toolbar_icon.png|Color picker}} the following highlights

<code>
<hi cyan>named cyan highlight</hi>

<hi>default highlight with **some bold** text</hi>

<hi #e0e>3-hex magenta highlight</hi> <hi #f30>or red</hi>
</code>
which looks as

{{:plugin:highlight_plugin.png?nolink|Highlight plugin in action}}

In a highlight you cannot apply a second highlight:
<code>
<hi cyan>cyan with <hi pink>pink in the middle</hi> of the highlight</hi>
 --- doesn't work

you <hi cyan>need to </hi><hi pink>do it</hi><hi cyan> this</hi> way
</code>

{{:plugin:highlight_plugin_explain.png?nolink|No nested syntax}}

==== Syntax Details====

You surround the text that you would like to highlight with the tags ''<hi //color//>'' and ''</hi>''.
Here //color// can be any of:

    - A three or six hexadecimal color value [ e.g. //#E8E// or //#7fffd4// ]
    - One of the standard color names [ e.g. //white//, //black//, //aqua// ]
    - An decimal or percentage RGB color [ e.g. //rgb(55%, 35%, 25%)//, //rgb(255, 0, 255)// ]

  * __Note 1__: If //color// is omitted, a default of yellow (//#FF0//) will be used.
  * __Note 2__: This follows the W3C CSS standard for colors.  See: [[http://www.w3.org/TR/CSS21/syndata.html#color-units|the CSS2.1 spec]] for more detail.


===== Development =====

Although [[wikidesign@gmail.com|Esther Brunner]] already created a highlight
plugin, [[joe@nahmias.net|I]] felt it was limiting since it didn't allow the user to define
the color of the highlighting.  This plugin addresses that shortcoming and adds a nice
toolbar menu to choose from various predefined colors.  You can also customize the toolbar
to add additional colors if you wish.

You can try out this plugin on [[ncc@staddle.net|Neal]]'s wiki at [[http://www.staddle.net/wiki/plugins/highlight]].  He has also packaged a version for installation via the plugin manager. FIXED :-P Version for download includes all the corrections on this page - //[[ncc@staddle.net|Neal]] 2009-11-30//


==== Changelog ====

  * Version 3.1: Fix bug in IE when no user-defined colors exists; thanks [[ncc@staddle.net|Neal]]!   --- //[[joe+dokuwiki@nahmias.net|Joseph Nahmias]] 2006-09-06 15:39//
  * Version 3.0: Added support for user-defined colors  --- //[[joe+dokuwiki@nahmias.net|Joseph Nahmias]] 2006-09-06 00:40//
  * Version 2.2: Changed script.js to __not__ use a data: URL (No IE support), added Raw 3
  * Version 2.1: Changed toolbar icon to use a data: URL for ease of installation
  * Version 2.0: Added javascript toolbar picker
  * Version 1.0: Added highlight syntax code


===== Additional Colors  =====

To add more colors to the toolbar picker, add a duplicate of some blocks of ''[[https://github.com/munduch/dokuwiki-highlight/blob/master/script.js|script.js]]'' to your ''conf/userscript.js'' file (create it if it doesn't exist already):

Some examples of additional user-defined highlighting colors
  * "Indian Red":  "#cd5c5c",
  * "Khaki":       "#f0e68c",
  * "Powder Blue": "#b0e0e6",
  * "Sandy Brown": "#f4a460",
  * "Steel Blue":  "#4682b4",
  * "Thistle":     "#d8bfd8",
  * "Yellow Green":"#9acd32",
  * "Dark Violet": "#9400d3",
  * "Maroon":      "#800000"

For more additional colors (with names) check out the page at: [[http://www.w3schools.com/css/css_colornames.asp|W3Schools]].