Clear message

Color2

A simple macro to create colored text. One can optionally also set background color and font.

Note: MacroMarket/span is a somewhat related, more powerful macro, but if one needs only colored text, this macro is much simpler to use.

• Python versions - 2.5+

• Moin versions - 1.5, 1.6, 1.9

• Copyright - ClifKussmaul, DaveHein, GregorMirai

• License - GNU GPL version 2

• Download - Latest version 2011.2.23 - 1.9.3-1

Download & Release Notes

Note: should be installed as Color2.py

Usage

<<Color2(text,col=text_color,bcol=background_color,font=font_name)>>

Example

Tested in MoinMoin 1.9.3 (2011.02.23)

Colored text (syntax as of MoinMoin 1.9.3):

Example, in normal text:

<<Color2(red courier on blue,col=red,bcol=blue,font=courier)>>

<<Color2(Green Font on Yellow Background,green,yellow)>>

<<Color2(Orange Text,orange)>>

<<Color2("Text with commas:one,two,three",red)>>

<<Color2("Optional parameters",bcol=yellow)>>

Tested in MoinMoin 1.8.2 (2009.03.12)

Colored text (syntax as of MoinMoin 1.7.1):

In normal text

<<Color2(color,bgcolor,font,text)>>
<<Color2(color,bgcolor,text)>>
<<Color2(color,text)>>

Example, in normal text:

<<Color2(red,blue,courier,red courier on blue)>>

<<Color2(green,yellow,Green Font on Yellow Background)>>

<<Color2(orange,Orange Text)>>

Result (somehow, courier does not work? example from "Description" above):

Also works within tables:

||<<Color2(red,blue,courier,red courier on blue)>><<BR>><<Color2(green,yellow,Green Font on Yellow Background)>><<BR>><<Color2(orange,Orange Text)>>||

||<style="background-color: #CCFFFF;"> <!> '''Notice!'''<<BR>>The allocation of IP addresses for the abc interfaces on the host start with 10.10.<<Color2(red,1)>>.<<Color2(red,1)>> --> (abc server .<<Color2(red,rack 1, rack position 1)>>). ||

Bugs

This macro should be refactored

1. use of arg parser for macros (DONE - default parameter parsing for macros in 1.9.X)

2. use of wikiutil.renderText() (DONE)

3. user input needs to be escaped XSS problems (DONE - uses formatter.escapedText(text))

Discussion

• If there is no syntax given by the autors, you might find some information in the .py file itself. (DONE - usage described)

• When using super or subscript modifiers Color2 does not work -- PeterGurk

• This macro does not give an easy way to color text that has commas in it. -- JohnJHarrison (DONE - result of default par. parsing in 1.9.X)

  • It seems that this macro also supports colon (:) as a delimiter, which could be a workaround for the comma (,) issue. Nonetheless, since both (,) and (:) are frequently used in normal texts, how about allowing it use a bar (|) rather than comma (,)? Example: Color2_bar.py. -- TakeoKatsuki 2009-08-08 01:58:56

    <<Color2(black|yellow|For example, color2 will work fine with commas and colons like this: black, yellow, and green.)>>

    

    • It should also work if the text is entered quoted. comma is the delimiter for arguments if the argumentparser is involved.

      <<Color2(black,yellow,"For example, color2 will work fine with commas and colons like this: black, yellow, and green.")>> so it makes sense for one using this macro to refactor it to use the argument parser and while doing this also to fix the XSS problem.

      • Currently it doesn't work with quote, right?

        • Yes, because it is not using the argument parser. Besides looking into the moin macros e.g. EmbedObject.py a simple example is given at HelloWorld-1.7 (macro examples).

• When using with MoinMoin 1.8.2 the macro seems to add a line break after the coloured text in the preview pane. The page is displayed correctly though. -- SamRoy

• I've tested this "break line" with 1.6 and 1.7, and the reason is somewhere in formattext procedure. -- KrisR

• Anyone tested the Color2 macro on 1.9.3? Thanks. -- lanepierce (DONE)