Merge commit 'upstream/master' into pub/master

[git.ikiwiki.info.git] / doc / todo / color_plugin.mdwn

diff --git a/doc/todo/color_plugin.mdwn b/doc/todo/color_plugin.mdwn
index fa460a386a2519c7ba61b7583a0b6627ee5121a8..69afe837d1f66ef8b5721c9357fc44487dd316b3 100644 (file)
--- a/doc/todo/color_plugin.mdwn
+++ b/doc/todo/color_plugin.mdwn
@@ -46,19 +46,42 @@ This is a RC1 of my `color` plugin. It works for me well, but all your
 comments are very welcome. --[[Paweł|ptecza]]
 
 > Sure, I have a couple.
 comments are very welcome. --[[Paweł|ptecza]]
 
 > Sure, I have a couple.

-> 
+
+>> Great! Thank you very much! --[[Paweł|ptecza]]
+

 > The preprocess function is passed named parameters. The hack you have of
 > hardcoding use of `$_[0]` and `$_[2]` can fail at any time.
 > The preprocess function is passed named parameters. The hack you have of
 > hardcoding use of `$_[0]` and `$_[2]` can fail at any time.

-> 
+
+>> But the problem is that arguments of my plugin don't have a name.
+>> How can I identify them in `params` hash?
+
+>> Similar hardcoded method I've found in `img` plugin :) But only one
+>> argument is not named there (image path).
+
+>>> I think I hadn't realized what you were doing there. The order
+>>> for unnamed parameters can in fact be relied on. 
+>>> 
+>>> --[[Joey]]
+
+>> Maybe I shouldn't use so simple plugin syntax? For following syntax
+>> I wouldn't have that problem:
+
+>>     \[[!color fg=white bg=red text="White text on red background"]]
+

 > `replace_preserved_style` is passed a single parameter, so its prototype
 > should be `($)`, not `(@)`.  Ditt `preserve_style`, it should have
 > `($$)`.
 > `replace_preserved_style` is passed a single parameter, so its prototype
 > should be `($)`, not `(@)`.  Ditt `preserve_style`, it should have
 > `($$)`.

-> 
+
+>> OK, it will be fixed.
+

 > The sanitize hook is always passed `$params{content}`, so there should be
 > no reason to check that it exists. Also, it shouldn't be done in a
 > sanitize hook, since html sanitization could run _after_ that santize
 > hook. It should use a format hook.
 > The sanitize hook is always passed `$params{content}`, so there should be
 > no reason to check that it exists. Also, it shouldn't be done in a
 > sanitize hook, since html sanitization could run _after_ that santize
 > hook. It should use a format hook.

-> 
+
+>> Probably you're right. It was rather paranoid checking ;) Thanks for
+>> the hook hint!
+

 > The preprocess hook needs to call `IkiWiki::preprocess` on the content
 > passed into it if you want to support nesting other preprocessor
 > directives inside the color directive. See `preprocess_toggleable` in the
 > The preprocess hook needs to call `IkiWiki::preprocess` on the content
 > passed into it if you want to support nesting other preprocessor
 > directives inside the color directive. See `preprocess_toggleable` in the


@@ -68,12 +91,41 @@ comments are very welcome. --[[Paweł|ptecza]]
 > The method used by toggle of using two real `<div>`s seems slightly
 > better. --[[Joey]]
 
 > The method used by toggle of using two real `<div>`s seems slightly
 > better. --[[Joey]]
 

-       --- /dev/null   2008-07-24 09:38:19.000000000 +0200
-       +++ color.pm    2008-07-25 14:43:15.000000000 +0200
-       @@ -0,0 +1,75 @@
+>> I don't like that too, but I didn't have better idea :) Thank you for
+>> the hint! I'll take a look at `toggle` plugin.
+
+---
+
+And here is RC2 of that plugin. I've changed a plugin syntax, because the old
+seems to be too enigmatic and it was hard to me to handle unnamed parameters
+in not hardcoded way. I hope that my changes are acceptable for you.
+Of course, I'm open for discussion or exchange of ideas :) --[[Paweł|ptecza]]
+
+> One question, why the 2px padding for span.color? --[[Joey]]
+
+>> Sorry for a long silence, but I had Internet free summer holiday :)
+>> I did that, because backgrounded text without any padding looks
+>> strange for me ;) You can remove it if you don't like that padding.
+>> --[[Paweł|ptecza]]
+
+>>> Joey, will you add that plugin to Ikiwiki 2.61? :) --[[Paweł|ptecza]]
+
+>>>> I also had a long net-free summer holiday. :-) The [[patch]] is
+>>>> ready for integration (made a few minor changes). Is this GPL 2?
+>>>> --[[Joey]]
+
+>>>>> No problem. I guessed it, because I've not seen your commits
+>>>>> at [[RecentChanges]] page in last days and I subscribe your
+>>>>> [blog](http://kitenet.net/~joey/blog/entry/vacation/) :D
+>>>>> It's GPL-2+ like your Ikiwiki and the most external plugins.
+>>>>> --[[Paweł|ptecza]]
+
+       --- /dev/null   2008-06-21 02:02:15.000000000 +0200
+       +++ color.pm    2008-07-27 14:58:12.000000000 +0200
+       @@ -0,0 +1,69 @@

        +#!/usr/bin/perl
        +# Ikiwiki text colouring plugin
        +#!/usr/bin/perl
        +# Ikiwiki text colouring plugin

-       +# Paweł Tęcza <ptecza@net.icm.edu.pl>
+       +# Paweł‚ Tęcza <ptecza@net.icm.edu.pl>

        +package IkiWiki::Plugin::color;
        +
        +use warnings;
        +package IkiWiki::Plugin::color;
        +
        +use warnings;


@@ -82,101 +134,98 @@ comments are very welcome. --[[Paweł|ptecza]]
        +
        +sub import { #{{{
        +       hook(type => "preprocess", id => "color", call => \&preprocess);
        +
        +sub import { #{{{
        +       hook(type => "preprocess", id => "color", call => \&preprocess);

-       +       hook(type => "sanitize",   id => "color", call => \&sanitize);
+       +       hook(type => "format",     id => "color", call => \&format);

        +} #}}}
        +
        +} #}}}
        +

-       +sub preserve_style(@) { #{{{
-       +       my ($colors, $text) = @_;
-       +       $colors = '' unless $colors;    # foreground and background colors
-       +       $text   = '' unless $text;      # text
-       +       
-       +       # Check colors
-       +       my ($color1, $color2) = ();
-       +       $colors = lc($colors);  # Regexps on lower case strings are simpler
-       +       if ($colors =~ /,/) {
-       +               # Probably defined both foreground and background color
-       +               ($color1, $color2) = ($colors =~ /(.*),(.*)/);
-       +       }
-       +       else {
-       +               # Probably defined only foreground color
-       +               ($color1, $color2) = ($colors, '');
-       +       }
-       +       
+       +sub preserve_style ($$$) { #{{{
+       +       my $foreground = shift;
+       +       my $background = shift;
+       +       my $text       = shift;
+       +
+       +       $foreground = defined $foreground ? lc($foreground) : '';
+       +       $background = defined $background ? lc($background) : '';
+       +       $text       = '' unless (defined $text);
+       +

        +       # Validate colors. Only color name or color code are valid.
        +       # Validate colors. Only color name or color code are valid.

-       +       my ($fg, $bg) = ();
-       +       $fg = $color1 if ($color1 &&
-       +                        ($color1 =~ /^[a-z]+$/ || $color1 =~ /^#[0-9a-f]{3,6}$/));
-       +       $bg = $color2 if ($color2 &&
-       +                        ($color2 =~ /^[a-z]+$/ || $color2 =~ /^#[0-9a-f]{3,6}$/));
+       +       $foreground = '' unless ($foreground &&
+       +                               ($foreground =~ /^[a-z]+$/ || $foreground =~ /^#[0-9a-f]{3,6}$/));
+       +       $background = '' unless ($background &&
+       +                               ($background =~ /^[a-z]+$/ || $background =~ /^#[0-9a-f]{3,6}$/));

        +
        +       my $preserved = '';
        +
        +       my $preserved = '';

-       +       if ($fg || $bg) {
-       +               $preserved .= 'COLORS {';
-       +               $preserved .= 'color: '.$fg if ($fg);
-       +               $preserved .= '; ' if ($fg && $bg);
-       +               $preserved .= 'background-color: '.$bg if ($bg);
-       +               $preserved .= '} SROLOC;TEXT {'.$text.'} TXET';
-       +       }
+       +       $preserved .= '<span class="color">';
+       +       $preserved .= 'color: '.$foreground if ($foreground);
+       +       $preserved .= '; ' if ($foreground && $background);
+       +       $preserved .= 'background-color: '.$background if ($background);
+       +       $preserved .= '</span>';
+       +       $preserved .= '<span class="colorend">'.$text.'</span>';

        +       
        +       return $preserved;
        +
        +} #}}}
        +
        +       
        +       return $preserved;
        +
        +} #}}}
        +

-       +sub replace_preserved_style(@) { #{{{
+       +sub replace_preserved_style ($) { #{{{

        +       my $content = shift;
        +
        +       my $content = shift;
        +

-       +       if ($content) {
-       +               $content =~ s/COLORS {/<span style="/;
-       +               $content =~ s/} SROLOC;TEXT {/">/;
-       +               $content =~ s/} TXET/<\/span>/;
-       +       }
+       +       $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;
+       +       $content =~ s!<span class="colorend">!!g;

        +
        +

-       +       return $content; 
+       +       return $content;

        +} #}}}
        +
        +sub preprocess (@) { #{{{
        +} #}}}
        +
        +sub preprocess (@) { #{{{

-       +       return preserve_style($_[0], $_[2]);
+       +       my %params = @_;
+       +
+       +       # Preprocess the text to expand any preprocessor directives
+       +       # embedded inside it.
+       +       $params{text} = IkiWiki::preprocess($params{page}, $params{destpage},
+       +                               IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
+       +
+       +       return preserve_style($params{foreground}, $params{background}, $params{text});

        +} #}}}
        +
        +} #}}}
        +

-       +sub sanitize (@) { #{{{
+       +sub format (@) { #{{{

        +       my %params = @_;
        +       my %params = @_;

-       +       
-       +       return replace_preserved_style($params{content})
-       +               if (exists $params{content})
+       +
+       +       $params{content} = replace_preserved_style($params{content});
+       +       return $params{content};        

        +} #}}}
        +
        +1
        +} #}}}
        +
        +1

-       --- /dev/null   2008-07-24 09:38:19.000000000 +0200
-       +++ color.mdwn  2008-07-25 14:50:19.000000000 +0200
-       @@ -0,0 +1,31 @@
-       +\[[!template id=plugin name=color core=0 author="[[Paweł Tęcza|ptecza]]"]]
+       --- /dev/null   2008-06-21 02:02:15.000000000 +0200
+       +++ color.mdwn  2008-07-27 15:04:42.000000000 +0200
+       @@ -0,0 +1,25 @@
+       +\[[!template id=plugin name=color core=0 author="[[ptecza]]"]]

        +
        +

-       +This plugin can be used to color a piece of text on Ikiwiki page.
-       +It's possible setting foreground and/or background color of the text.
+       +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.

        +
        +

-       +The plugin syntax is very simple. You only need to type name (e.g. `white`)
-       +or HTML code of colors (e.g. `#ffffff`) and a text you want to color.
-       +The colors should by separated using a comma character.
+       +You can use a color name (e.g. `white`) or HTML code (e.g. `#ffffff`)
+       +to define colors. 

        +
        +Below are a few examples:
        +
        +
        +Below are a few examples:
        +

-       +    \[[!color white,#ff0000 "White text on red background"]]
+       +    \[[!color foreground=white background=#ff0000 text="White text on red background"]]

        +
        +

-       +Foreground color is defined as a word, background color is defined as HTML
+       +In the above example, the foreground color is defined as a word, while the background color is defined as a HTML

        +color code.
        +
        +color code.
        +

-       +    \[[!color white "White text on default color background"]]
-       +
-       +Foreground color is default color if only one color was typed and a comma
-       +character is missing.
+       +    \[[!color foreground=white text="White text on default color background"]]

        +
        +

-       +    \[[!color white, "White text on default color background"]]
+       +The background color is missing, so the text is displayed on default background.

        +
        +

-       +Background color is missing, so the text is displayed on default background.
+       +    \[[!color background=#ff0000 text="Default color text on red background"]]

        +
        +

-       +    \[[!color ,#ff0000 "Default color text on red background"]]
+       +The foreground is missing, so the text has the default foreground color.
+       --- style.css-orig      2008-07-27 15:12:39.000000000 +0200
+       +++ style.css   2008-07-27 15:15:06.000000000 +0200
+       @@ -333,3 +333,7 @@
+               background: #eee; 
+               color: black !important;
+        }

        +
        +

-       +Foreground is missing, so the text has default color.
-       +
-       +This plugin is not enabled by default. You can do that in [[ikiwiki.setup]]
-       +file (hint: `add_plugins` variable).
+       +span.color {
+       +       padding: 2px;
+       +}
+
+[[done]]