From version 28.1
edited by Denis Gervalle
on 2015/10/22 10:23
To version 29.1
edited by Denis Gervalle
on 2015/10/22 10:48
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Authors
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.asiri
1 +xwiki:XWiki.asiri xwiki:XWiki.dgervalle
Description
... ... @@ -1,6 +1,61 @@
1 +This wiki macro allows drawing styled boxes around wiki content. Layout of these styled boxes are different from that of [[Box Macro]] generated boxes and the look and feel of these boxes can be centrally controlled by editing the associated [[style sheet extension>>platform:DevGuide.SkinExtensionsTutorial]] attached to the wiki macro document.
2 +
3 +{{warning}}
4 +The first version of this macro was written by Asiri Rathnayake, this version is appropriate for wikis in version earlier than 3.0, or for those wanting strict compatibility with that version of the macro. **This first version was not installable with EM, and should be uninstalled manually before installing version 2.0 (delete the macro document Macro.MBox)**.
5 +
6 +Version 2.0 is mostly compatible with this first version, with the following slight changes:
7 + * works almost seamlessly with Colibri and Flamingo skins
8 + * slight spacing change could happen compare to the earlier macro
9 + * the generated HTML differs, so if you have customized the styles, this may need to be adapted
10 + * the macro content should stick strictly to the initial documentation which requires XWiki syntax only (while the implementation was accepting HTML content)
11 + * the icon parameter syntax is now more relaxed, accepting the same syntax as the image: syntax.
12 + * the XWiki Syntax supported by the macro is now 2.1 (while it was 2.0 in previous implementation)
13 +{{/warning}}
14 +
15 +== Macro Name ==
16 +mbox
17 +
18 +== Parameters ==
19 +; title (% style="font-size:80%;font-weight:normal;" %)//(required)//
20 +: A title for the box.
21 +
22 +; subTitle
23 +: An optional subtitle.
24 +
25 +; icon
26 +: An 22x22 pixel icon to be displayed on top-left corner of the box. Icon reference should be of the form wiki:[email protected] or icon:iconname. A default cog icon is used when none is provided.
27 +
28 +; width
29 +: Width of the box, can be any css length specification (75%, 100px, 3em, ...).
30 +
31 +; color
32 +: Background color of the box, can be any css color specification (red, #1A2B6E, ...).
33 +
34 += Exemples
35 +== Code ==
36 +|(% width="50%" %) (((
37 +{{code}}
38 +{{mbox title="A Title" subTitle="An Optional **Sub-Title**"}}
39 +Any **xwiki** content.
40 +{{/mbox}}
41 +{{/code}}
42 +))) |(% width="50%" %) (((
43 +{{code}}
44 +{{mbox title="A Title" icon="[email protected]" color="lightblue"}}
45 +Any **xwiki** content.
46 +{{/mbox}}
47 +{{/code}}
48 +)))
49 +
50 +== Results ==
51 +
52 +{{image reference="mbox2.png"/}}
53 +
54 +== Documentation of initial version by Asiri Rathnayake ==
55 +
1 1  This wiki macro allows drawing styled boxes around wiki content. Layout of these styled boxes are different from that of [[Box Macro]] generated boxes and the look and feel of these boxes can be centrally controlled by editing the associated [[style sheet extension>>platform:DevGuide.SkinExtensionsTutorial]] attached to the wiki macro document. Also, MBox macro can be [[easily extended>>http://asiri.rathnayake.org/2009/10/11/xwiki-customize-presentation-with-wiki-macros/]] to create new sub macros for convenience.
2 2  
3 -== Installation ==
58 +=== Installation ===
4 4  
5 5  {{warning}}
6 6  Wiki macros are only available for XE versions greater than 2.0M2
... ... @@ -8,7 +8,7 @@
8 8  
9 9  You can install the MBox macro by downloading the [[XAR bundle>>http://dl.dropbox.com/u/12212624/XWiki/Macro.MBox.xar]] and importing it to your wiki with programming rights. Note that if you are running an XWiki farm, the installation needs to happen on the main wiki.
10 10  
11 -== Usage ==
66 +=== Usage ===
12 12  
13 13  {{code}}
14 14  {{mbox title="A Title"}}
... ... @@ -16,7 +16,7 @@
16 16  {{/mbox}}
17 17  {{/code}}
18 18  
19 -=== Parameters Definition ===
74 +==== Parameters Definition ====
20 20  
21 21  |=Name|=Optional|=Default Value|=Description
22 22  |**##title##**|No|None|Title of the box (to be displayed on top of the content)
... ... @@ -25,7 +25,7 @@
25 25  |**##width##**|Yes|**##auto##**|Width of the box, can be any css width specification (Eg. **##75%##**)
26 26  |**##color##**|Yes|**###CCCC99##**|Background color of the box, can be any css color specification (Eg. **##red##**)
27 27  
28 -== Example ==
83 +=== Example ===
29 29  
30 30  {{code}}
31 31  {{mbox title="A Title" subTitle="An Optional **Sub-Title**" width="75%"}}
... ... @@ -33,10 +33,10 @@
33 33  {{/mbox}}
34 34  {{/code}}
35 35  
36 -=== Screenshot ===
91 +==== Screenshot ====
37 37  
38 38  {{image reference="mbox.png"/}}
39 39  
40 -=== Notes ===
95 +==== Notes ====
41 41  
42 42  Please refer to [[this blog post>>http://asiri.rathnayake.org/2009/10/11/xwiki-customize-presentation-with-wiki-macros/]] for more examples and information on customizing the MBox macro.
Last version
... ... @@ -1,0 +1,1 @@
1 +2.0
ExtensionCode.ExtensionVersionClass[0]
Download URL
... ... @@ -1,1 +1,1 @@
1 -url:http://dl.dropbox.com/u/12212624/XWiki/Macro.MBox.xar
1 +attach:mboxmacro-2.0.xar
id
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.contrib:macro-mbox
Version
... ... @@ -1,0 +1,1 @@
1 +2.0

Get Connected