aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/color.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-26 13:22:34 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-26 13:22:34 -0400
commit042a0577780ca1783ce8cb4d9a050fa115f6cd6b (patch)
tree48d4cb370193221daa347d206fda83f527d8d5f3 /doc/plugins/color.mdwn
parent6364949dfced5cdbba5014d34dbf0e7f0980cd27 (diff)
downloadikiwiki-042a0577780ca1783ce8cb4d9a050fa115f6cd6b.tar
ikiwiki-042a0577780ca1783ce8cb4d9a050fa115f6cd6b.tar.gz
color: New plugin from ptecza.
Diffstat (limited to 'doc/plugins/color.mdwn')
-rw-r--r--doc/plugins/color.mdwn23
1 files changed, 23 insertions, 0 deletions
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"]]