Differences

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

--- plugin:color [2022-10-19 10:03] – [Usage] hanche
+++ plugin:color [2024-02-08 08:12] (current) – rnck
@@ Line 6: / Line 6: @@
 email      : harald.hanche-olsen@ntnu.no
 type       : Syntax
-lastupdate : 2022-10-16
+lastupdate : 2022-10-19
-compatible : 2009-12-25, 2010-11-07, 2011-05-25, 2012-01-25, 2014-05-05, 2014-09-29d, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Detritus,Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
+compatible : Adora Belle, Weatherwax, Binky, Ponder Stibbons, Detritus, Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : typography, highlight, color, text
-downloadurl: https://github.com/hanche/dokuwiki_color_plugin/archive/refs/tags/2022-10-16.tar.gz
+downloadurl: https://github.com/hanche/dokuwiki_color_plugin/archive/refs/tags/2022-10-19.tar.gz
 sourcerepo : https://github.com/hanche/dokuwiki_color_plugin
 bugtracker : https://github.com/hanche/dokuwiki_color_plugin/issues
@@ Line 34: / Line 34: @@
 <color /#FFff00>text</color>
 <color rgb(80%,0%,0%)/rgb(100%,80%,100%)>text</color>
-<color hsl(120,100%,30%)/hsl(180,50%,90%)>text</color>
+<color hsl(120,100%,30%):hsl(180,50%,90%)>text</color>
 </code>
@@ Line 41: / Line 41: @@
 {{https://folk.ntnu.no/hanche/tmp/dokuwiki_color_plugin.png|Color plugin in action}}
-More precisely, allowed syntax is one of
+The foreground or background color specification can be any valid CSS color specification. Beware that some older browsers will not recognise all color specs in the latest CSS version.
+If you use a color specification that contains a slash (''/''), you must use a colon ('':'') to separate the foreground and background color specs.
+The precise syntax is as follows. Square brackets (''[]'') indicate optional parts, and should //not// be included literally:
 <code>
-<color ⟨fg-color⟩>⟨text⟩</color>
+<color [⟨fg-color⟩][/⟨bg-color⟩]>⟨text⟩</color>
-<color ⟨fg-color⟩/⟨bg-color⟩>⟨text⟩</color>
+<color [⟨fg-color⟩]:[⟨bg-color⟩]>⟨text⟩</color>
-<color /⟨bg-color⟩>⟨text⟩</color>
 </code>
+You //must// use the second form if either color spec includes a slash.
+Note that in that case, the colon separater ('':'') is mandatory.
-The result is ⟨text⟩ shown with foreground color ⟨fg-color⟩ and background color ⟨bg-color⟩. If either color is omitted, the color of the surrounding text is used.
+No valid color spec including a colon is known at this time, but if you need to use one in the future, you //must// use the first form. This plugin does not provide a way to combine these.
-This plugin now allows any color specification not containing single or double quotes or any of the symbols %%< > & ; / %%. It does not try to check if the specification is valid CSS. This is to accommodate the CSS 4 color specifications, as well as any future color specifications – so long as they do not use any of the “forbidden” characters.
+The result is ⟨text⟩ shown with foreground color ⟨fg-color⟩ and background color ⟨bg-color⟩. If either color is omitted or empty, the foreground or background color of the surrounding text is used.
+Example – note the mandatory colon here:
+<code>
+<color hwb(120 20% 30% / 50%):>some faded dark green semi-transparent text</color>
+</code>
+Harmless restriction:
+This plugin now allows any color specification not containing single or double quotes or any of the symbols ''%%< > & ; %%''. It does not try to check if the specification is valid CSS. This is to accommodate the CSS 4 color specifications, as well as any future color specifications – so long as they do not use any of the “forbidden” characters.
 For a reference of usable color specifications, see
@@ Line 60: / Line 74: @@
   * The plugin works by wrapping contents in a %%<span>%% element with a suitable %%style%% attribute. Therefore, you cannot wrap it around block level items such as headers, lists, and tables.
   * You cannot use it //inside// headers either, since [[faq:headerlinks|you can't use wiki syntax]] within a header.
+  * The use of two or more separators (slashes in the first syntax, colons in the second) within %%''<color …>''%% results in undefined behaviour.
 ===== Discussion =====
@@ Line 66: / Line 82: @@
 ===== Development =====
-Christopher Smith seems to have left the plugin unmaintained. User leeyc0 provided hosting of the plugin on github, but has no time to maintain it either. Harald Hanche-Olsen took over in October 2018. The plugin is considered fairly stable, though, and the new maintainer does not foresee a very active maintenance schedule. New feature requests will likely be rejected.
+**Christopher Smith** seems to have left the plugin unmaintained. User **leeyc0** provided hosting of the plugin on github, but has no time to maintain it either. **Harald Hanche-Olsen** took over in October 2018. The plugin is considered fairly stable, though, and the new maintainer does not foresee a very active maintenance schedule. New feature requests will likely be rejected.
 ===== Update History =====
+  * 2022-10-19 Allow the use of a colon separator, so that the color specs may contain a slash
+  * 2022-10-16 Removed the (too stringent) syntax checking of the color specifications, in order to be able to handle CSS 4 colors and possible future color specs
   * 2022-09-15 Removed deprecated and unnecessary (but harmless) code
   * 2018-10-12 New maintainer