From 042a0577780ca1783ce8cb4d9a050fa115f6cd6b Mon Sep 17 00:00:00 2001
From: Joey Hess <joey@kodama.kitenet.net>
Date: Tue, 26 Aug 2008 13:22:34 -0400
Subject: color: New plugin from ptecza.

---
 doc/plugins/color.mdwn | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 doc/plugins/color.mdwn

(limited to 'doc/plugins/color.mdwn')

diff --git a/doc/plugins/color.mdwn b/doc/plugins/color.mdwn
new file mode 100644
index 000000000..a5100d8de
--- /dev/null
+++ b/doc/plugins/color.mdwn
@@ -0,0 +1,23 @@
+\[[!template id=plugin name=color core=0 author="[[ptecza]]"]]
+
+This plugin can be used to color a piece of text on a page.
+It can be used to set the foreground and/or background color of the text.
+
+You can use a color name (e.g. `white`) or HTML code (e.g. `#ffffff`)
+to define colors. 
+
+## examples
+
+Here the foreground color is defined as a word, while the background color
+is defined as a HTML color code:
+
+	\[[!color foreground=white background=#ff0000 text="White text on red background"]]
+
+The background color is missing, so the text is displayed on default
+background:
+
+	\[[!color foreground=white text="White text on default color background"]]
+
+The foreground is missing, so the text has the default foreground color:
+
+	\[[!color background=#ff0000 text="Default color text on red background"]]
-- 
cgit v1.2.3