update
[ikiwiki.git] / doc / todo / color_plugin.mdwn
1 Recently I've wanted to colour some piece of text on my Ikiwiki page.
2 It seems that Markdown can do it only using HTML tags, so I used
3 `<span class="color">foo bar baz</span>`.
4
5 However, in my opinion mixing Markdown syntax and HTML tags is rather ugly,
6 so maybe we should create a new color plugin to add more color to Ikiwiki ;)
7 I know that another Wikis have similar plugin, for example
8 [WikiDot](http://www.wikidot.com/).
9
10 I've noticed that htmlscrubber plugin strips `style` attribute, because of
11 security, so probably we need to use `class` attribute of HTML. But then
12 we have to customize our `local.css` file to add all color we want to use.
13 It's not as easy in usage like color name or definition as plugin argument,
14 but I don't have a better idea right now.
15
16 What do you think about it? --[[Paweł|ptecza]]
17
18 > Making a plugin preserve style attributes can be done, it just has to add
19 > them after the sanitize step, which strips them. The general method is
20 > adding placeholders first, and replacing them with the real html later.
21
22 > The hard thing to me seems to be finding a syntax that is better than a
23 > `<span>`. A preprocessor directive is not really any less ugly than html
24 > tags, though at least it could play nicely with nested markdown: --[[Joey]]
25
26 >       \[[!color red,green """
27 >       Xmas-colored markdown here
28 >       """]]
29
30 >> I'm glad you like that idea. In my opinion your syntax looks good.
31 >> Out of curiosity, why did you used 2 colors in your example? What is HTML
32 >> result for it? ;)
33
34 >>> I was thinking one would be foreground, the other background. Don't
35 >>> know if setting the background makes sense or not.
36
37 >> I can try to create that plugin, if you are too busy now. I'm not Perl
38 >> hacker, but I wrote a lot of Perl scripts in my life and color plugin
39 >> doesn't seem to be very hard task. --[[Paweł|ptecza]]
40
41 >> Yes, it's a good intro plugin, have at it! --[[Joey]]
42
43 ---
44
45 This is a RC1 of my `color` plugin. It works for me well, but all your
46 comments are very welcome. --[[Paweł|ptecza]]
47
48 > Sure, I have a couple.
49
50 >> Great! Thank you very much! --[[Paweł|ptecza]]
51
52 > The preprocess function is passed named parameters. The hack you have of
53 > hardcoding use of `$_[0]` and `$_[2]` can fail at any time.
54
55 >> But the problem is that arguments of my plugin don't have a name.
56 >> How can I identify them in `params` hash?
57
58 >> Similar hardcoded method I've found in `img` plugin :) But only one
59 >> argument is not named there (image path).
60
61 >> Maybe I shouldn't use so simple plugin syntax? For following syntax
62 >> I wouldn't have that problem:
63
64 >>     \[[!color fg=white bg=red text="White text on red background"]]
65
66 > `replace_preserved_style` is passed a single parameter, so its prototype
67 > should be `($)`, not `(@)`.  Ditt `preserve_style`, it should have
68 > `($$)`.
69
70 >> OK, it will be fixed.
71
72 > The sanitize hook is always passed `$params{content}`, so there should be
73 > no reason to check that it exists. Also, it shouldn't be done in a
74 > sanitize hook, since html sanitization could run _after_ that santize
75 > hook. It should use a format hook.
76
77 >> Probably you're right. It was rather paranoid checking ;) Thanks for
78 >> the hook hint!
79
80 > The preprocess hook needs to call `IkiWiki::preprocess` on the content
81 > passed into it if you want to support nesting other preprocessor
82 > directives inside the color directive. See `preprocess_toggleable` in the
83 > toggle plugin, for example.
84
85 > I'm not a big fan of the dummy text `COLORS { ... } SROLOC;TEXT { ... TXET }`
86 > The method used by toggle of using two real `<div>`s seems slightly
87 > better. --[[Joey]]
88
89 >> I don't like that too, but I didn't have better idea :) Thank you for
90 >> the hint! I'll take a look at `toggle` plugin.
91
92         --- /dev/null   2008-07-24 09:38:19.000000000 +0200
93         +++ color.pm    2008-07-25 14:43:15.000000000 +0200
94         @@ -0,0 +1,75 @@
95         +#!/usr/bin/perl
96         +# Ikiwiki text colouring plugin
97         +# Paweł Tęcza <ptecza@net.icm.edu.pl>
98         +package IkiWiki::Plugin::color;
99         +
100         +use warnings;
101         +use strict;
102         +use IkiWiki 2.00;
103         +
104         +sub import { #{{{
105         +       hook(type => "preprocess", id => "color", call => \&preprocess);
106         +       hook(type => "sanitize",   id => "color", call => \&sanitize);
107         +} #}}}
108         +
109         +sub preserve_style(@) { #{{{
110         +       my ($colors, $text) = @_;
111         +       $colors = '' unless $colors;    # foreground and background colors
112         +       $text   = '' unless $text;      # text
113         +       
114         +       # Check colors
115         +       my ($color1, $color2) = ();
116         +       $colors = lc($colors);  # Regexps on lower case strings are simpler
117         +       if ($colors =~ /,/) {
118         +               # Probably defined both foreground and background color
119         +               ($color1, $color2) = ($colors =~ /(.*),(.*)/);
120         +       }
121         +       else {
122         +               # Probably defined only foreground color
123         +               ($color1, $color2) = ($colors, '');
124         +       }
125         +       
126         +       # Validate colors. Only color name or color code are valid.
127         +       my ($fg, $bg) = ();
128         +       $fg = $color1 if ($color1 &&
129         +                        ($color1 =~ /^[a-z]+$/ || $color1 =~ /^#[0-9a-f]{3,6}$/));
130         +       $bg = $color2 if ($color2 &&
131         +                        ($color2 =~ /^[a-z]+$/ || $color2 =~ /^#[0-9a-f]{3,6}$/));
132         +
133         +       my $preserved = '';
134         +       if ($fg || $bg) {
135         +               $preserved .= 'COLORS {';
136         +               $preserved .= 'color: '.$fg if ($fg);
137         +               $preserved .= '; ' if ($fg && $bg);
138         +               $preserved .= 'background-color: '.$bg if ($bg);
139         +               $preserved .= '} SROLOC;TEXT {'.$text.'} TXET';
140         +       }
141         +       
142         +       return $preserved;
143         +
144         +} #}}}
145         +
146         +sub replace_preserved_style(@) { #{{{
147         +       my $content = shift;
148         +
149         +       if ($content) {
150         +               $content =~ s/COLORS {/<span style="/;
151         +               $content =~ s/} SROLOC;TEXT {/">/;
152         +               $content =~ s/} TXET/<\/span>/;
153         +       }
154         +
155         +       return $content; 
156         +} #}}}
157         +
158         +sub preprocess (@) { #{{{
159         +       return preserve_style($_[0], $_[2]);
160         +} #}}}
161         +
162         +sub sanitize (@) { #{{{
163         +       my %params = @_;
164         +       
165         +       return replace_preserved_style($params{content})
166         +               if (exists $params{content})
167         +} #}}}
168         +
169         +1
170         --- /dev/null   2008-07-24 09:38:19.000000000 +0200
171         +++ color.mdwn  2008-07-25 14:50:19.000000000 +0200
172         @@ -0,0 +1,31 @@
173         +\[[!template id=plugin name=color core=0 author="[[Paweł Tęcza|ptecza]]"]]
174         +
175         +This plugin can be used to color a piece of text on Ikiwiki page.
176         +It's possible setting foreground and/or background color of the text.
177         +
178         +The plugin syntax is very simple. You only need to type name (e.g. `white`)
179         +or HTML code of colors (e.g. `#ffffff`) and a text you want to color.
180         +The colors should by separated using a comma character.
181         +
182         +Below are a few examples:
183         +
184         +    \[[!color white,#ff0000 "White text on red background"]]
185         +
186         +Foreground color is defined as a word, background color is defined as HTML
187         +color code.
188         +
189         +    \[[!color white "White text on default color background"]]
190         +
191         +Foreground color is default color if only one color was typed and a comma
192         +character is missing.
193         +
194         +    \[[!color white, "White text on default color background"]]
195         +
196         +Background color is missing, so the text is displayed on default background.
197         +
198         +    \[[!color ,#ff0000 "Default color text on red background"]]
199         +
200         +Foreground is missing, so the text has default color.