question
[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 >>> I think I hadn't realized what you were doing there. The order
62 >>> for unnamed parameters can in fact be relied on. 
63 >>> 
64 >>> --[[Joey]]
65
66 >> Maybe I shouldn't use so simple plugin syntax? For following syntax
67 >> I wouldn't have that problem:
68
69 >>     \[[!color fg=white bg=red text="White text on red background"]]
70
71 > `replace_preserved_style` is passed a single parameter, so its prototype
72 > should be `($)`, not `(@)`.  Ditt `preserve_style`, it should have
73 > `($$)`.
74
75 >> OK, it will be fixed.
76
77 > The sanitize hook is always passed `$params{content}`, so there should be
78 > no reason to check that it exists. Also, it shouldn't be done in a
79 > sanitize hook, since html sanitization could run _after_ that santize
80 > hook. It should use a format hook.
81
82 >> Probably you're right. It was rather paranoid checking ;) Thanks for
83 >> the hook hint!
84
85 > The preprocess hook needs to call `IkiWiki::preprocess` on the content
86 > passed into it if you want to support nesting other preprocessor
87 > directives inside the color directive. See `preprocess_toggleable` in the
88 > toggle plugin, for example.
89
90 > I'm not a big fan of the dummy text `COLORS { ... } SROLOC;TEXT { ... TXET }`
91 > The method used by toggle of using two real `<div>`s seems slightly
92 > better. --[[Joey]]
93
94 >> I don't like that too, but I didn't have better idea :) Thank you for
95 >> the hint! I'll take a look at `toggle` plugin.
96
97 ---
98
99 And here is RC2 of that plugin. I've changed a plugin syntax, because the old
100 seems to be too enigmatic and it was hard to me to handle unnamed parameters
101 in not hardcoded way. I hope that my changes are acceptable for you.
102 Of course, I'm open for discussion or exchange of ideas :) --[[Paweł|ptecza]]
103
104 > One question, why the 2px padding for span.color? --[[Joey]]
105
106         --- /dev/null   2008-06-21 02:02:15.000000000 +0200
107         +++ color.pm    2008-07-27 14:58:12.000000000 +0200
108         @@ -0,0 +1,69 @@
109         +#!/usr/bin/perl
110         +# Ikiwiki text colouring plugin
111         +# Paweł‚ Tęcza <ptecza@net.icm.edu.pl>
112         +package IkiWiki::Plugin::color;
113         +
114         +use warnings;
115         +use strict;
116         +use IkiWiki 2.00;
117         +
118         +sub import { #{{{
119         +       hook(type => "preprocess", id => "color", call => \&preprocess);
120         +       hook(type => "format",     id => "color", call => \&format);
121         +} #}}}
122         +
123         +sub preserve_style($$$) { #{{{
124         +       my $foreground = shift;
125         +       my $background = shift;
126         +       my $text       = shift;
127         +
128         +       $foreground = defined $foreground ? lc($foreground) : '';
129         +       $background = defined $background ? lc($background) : '';
130         +       $text       = '' unless (defined $text);
131         +
132         +       # Validate colors. Only color name or color code are valid.
133         +       $foreground = '' unless ($foreground &&
134         +                               ($foreground =~ /^[a-z]+$/ || $foreground =~ /^#[0-9a-f]{3,6}$/));
135         +       $background = '' unless ($background &&
136         +                               ($background =~ /^[a-z]+$/ || $background =~ /^#[0-9a-f]{3,6}$/));
137         +
138         +       my $preserved = '';
139         +       $preserved .= '<span class="color">';
140         +       $preserved .= 'color: '.$foreground if ($foreground);
141         +       $preserved .= '; ' if ($foreground && $background);
142         +       $preserved .= 'background-color: '.$background if ($background);
143         +       $preserved .= '</span>';
144         +       $preserved .= '<span class="colorend">'.$text.'</span>';
145         +       
146         +       return $preserved;
147         +
148         +} #}}}
149         +
150         +sub replace_preserved_style($) { #{{{
151         +       my $content = shift;
152         +
153         +       $content =~ s!<span class="color">((color: ([a-z]+|\#[0-9a-f]{3,6})?)?((; )?(background-color: ([a-z]+|\#[0-9a-f]{3,6})?)?)?)</span>!<span class="color" style="$1">!g;
154         +       $content =~ s!<span class="colorend">!!g;
155         +
156         +       return $content;
157         +} #}}}
158         +
159         +sub preprocess(@) { #{{{
160         +       my %params = @_;
161         +
162         +       # Preprocess the text to expand any preprocessor directives
163         +       # embedded inside it.
164         +       $params{text} = IkiWiki::preprocess($params{page}, $params{destpage},
165         +                               IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
166         +
167         +       return preserve_style($params{foreground}, $params{background}, $params{text});
168         +} #}}}
169         +
170         +sub format(@) { #{{{
171         +       my %params = @_;
172         +
173         +       $params{content} = replace_preserved_style($params{content});
174         +       return $params{content};        
175         +} #}}}
176         +
177         +1
178         --- /dev/null   2008-06-21 02:02:15.000000000 +0200
179         +++ color.mdwn  2008-07-27 15:04:42.000000000 +0200
180         @@ -0,0 +1,25 @@
181         +\[[!template id=plugin name=color core=0 author="[[ptecza]]"]]
182         +
183         +This plugin can be used to color a piece of text on Ikiwiki page.
184         +It's possible setting foreground and/or background color of the text.
185         +
186         +You can use name (e.g. `white`) or HTML code of colors (e.g. `#ffffff`)
187         +to define colors. 
188         +
189         +Below are a few examples:
190         +
191         +    \[[!color foreground=white background=#ff0000 text="White text on red background"]]
192         +
193         +Foreground color is defined as a word, background color is defined as HTML
194         +color code.
195         +
196         +    \[[!color foreground=white text="White text on default color background"]]
197         +
198         +Background color is missing, so the text is displayed on default background.
199         +
200         +    \[[!color background=#ff0000 text="Default color text on red background"]]
201         +
202         +Foreground is missing, so the text has default color.
203         +
204         +This plugin is not enabled by default. You can do that in [[ikiwiki.setup]]
205         +file (hint: `add_plugins` variable).
206         --- style.css-orig      2008-07-27 15:12:39.000000000 +0200
207         +++ style.css   2008-07-27 15:15:06.000000000 +0200
208         @@ -333,3 +333,7 @@
209                 background: #eee; 
210                 color: black !important;
211          }
212         +
213         +span.color {
214         +       padding: 2px;
215         +}