wiki:NoteBoxPlugin

Version 20 (modified by rjollos, 3 years ago) (diff)

Refs #9740.

Note boxes with icons

Description

NoteBox Plugin will render an HTML-DivContainer in different colors with different Icons.
The following containers are possible:

  • [[NoteBox(warn, my Text)]]
    • will render a red div-container with the given Text and a stopsign-image
  • [[NoteBox(tip, my Text)]]
    • will render a green div-container with the given Text and a lightbulb-image
  • [[NoteBox(note, my Text)]]
    • will render a blue div-container with the given Text and a notepaper-image


It will look like this:

No image "notebox_preview_v0.1.png" attached to NoteBoxPlugin

The parse_args function from the Trac API is used to parse the input, therefore commas must be escaped with a backslash. That is, make the following replacement: , -> \,. Everything in the second argument is interpreted as wiki markup, however a second macro cannot be embedded within the macro.

Bugs/Feature Requests

Existing bugs and feature requests for NoteBoxPlugin are here.

If you have any issues, create a new ticket.

Download / Source

Download the zipped source from here.

You can check out NoteBoxPlugin from here using Subversion, or browse the source with Trac (the anchor will only be present in Trac 0.12 or later, so you'll have to scroll to the appropriate location the page in earlier version of Trac.

Installation

For detailed installation steps, please refer to t:TracPlugins. The following steps should work for most Trac configurations.

  1. Unzip the code and type
    $>python setup.py install
    
  2. or use easy_install as below then, restart web server, finally enable it at admin/general/plugins
    easy_install http://trac-hacks.org/svn/noteboxplugin/0.11
    

If the plugin is installed and functioning correctly, you should see example of its use at WikiMacros#NoteBox-macro.

Example

Use either

  • [[NoteBox(warn, my Text)]]
  • [[NoteBox(tip, my Text)]]
  • [[NoteBox(note, my Text)]]

where my Text can be replaced with your text.

Recent Changes

Error: Macro ChangeLog(noteboxplugin, 3) failed
No node noteboxplugin at revision 14341

Author/Contributors

Author: gruenebe
Maintainer: AdoptingHacks request by rjollos is pending: #9738
Contributors: