Last modified by Simon Urli on 2023/10/10

<
From version < 86.1 >
edited by Valdis Vitolins
on 2013/09/10
To version < 88.1 >
edited by Marius Dumitru Florea
on 2014/05/30
>
Change comment: Specify that there can be only one object of type XWiki.WikiMacroClass per wiki page.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.valdisvi
1 +XWiki.mflorea
Content
... ... @@ -28,7 +28,7 @@
28 28  
29 29  == Definition ==
30 30  
31 -Wiki macros are defined using objects of type ##XWiki.WikiMacroClass##. You define a wiki macro by creating a new wiki page and attaching to it an object of type ##XWiki.WikiMacroClass##. This class contains the following fields:
31 +Wiki macros are defined using objects of type ##XWiki.WikiMacroClass##. You define a wiki macro by creating a new wiki page and attaching to it an object of type ##XWiki.WikiMacroClass##. There can be only one object of type ##XWiki.WikiMacroClass## per wiki page (if you add more only the first will be used). This class contains the following fields:
32 32  
33 33  * Macro id: Id of the macro to be used by users when invoking your macro from wiki code
34 34  * Macro name: Name of the macro to be displayed on the wysiwyg editor
... ... @@ -55,9 +55,14 @@
55 55  
56 56  == Content ==
57 57  
58 -If macro content is used, it can be shown by executing following velocity code in macro body:
59 -{{code language="none"}}{{velocity}}$xcontext.macro.content{{/velocity}}{{/code}}
58 +If macro content is used, it can be shown by executing the following velocity code in the macro body:
60 60  
60 +{{code language="none"}}
61 +{{velocity}}$xcontext.macro.content{{/velocity}}
62 +{{/code}}
63 +
64 +For more details, see the [[Scripting Tips section below>>||anchor="HScriptingTips"]].
65 +
61 61  == Parameters ==
62 62  
63 63  Introducing a parameter to a wiki macro is pretty straight forward; you simply need to add an object of type ##XWiki.WikiMacroParameterClass## into your wiki macro document (one object per parameter). This class contains several fields that allow you to define your parameter clearly:

Get Connected