Last modified by Simon Urli on 2023/10/10

From version 121.1
edited by Michael Hamann
on 2022/06/28
Change comment: There is no comment for this version
To version 125.1
edited by Manuel Leduc
on 2022/07/11
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.MichaelHamann
1 +XWiki.mleduc
Content
... ... @@ -23,7 +23,7 @@
23 23  * **Macro id**: Id of the macro to be used by users when invoking your macro from wiki code
24 24  * **Macro name**: Name of the macro to be displayed on the wysiwyg editor
25 25  * **Macro description**: A short description of the macro to be displayed on the WYSIWYG editor
26 -* **Default category**: Default category under which this macro should be listed
26 +* **Default categories**: Default categories under which this macro should be listed {{warning}}before 14.4RC1 this was called **Default category**{{/warning}}
27 27  * **Supports inline mode**: Whether the macro can be used in an inline context or not
28 28  * **Macro Content availability**: {{warning}}before 11.5RC1 this was called **Macro Content Type**{{/warning}} whether this macro should support a body or not
29 29  * **Macro content type**: {{warning}}this field has been renamed **Macro Content Availability** since 11.5RC1{{/warning}} the type of accepted content: two values are proposed, ##WIKI## if this content should be editable like a wiki content, or ##UNKNOWN## if it should be displayed like a plain text. It's also possible to specify a custom java type such as {{code language="java"}}java.util.List<java.lang.String>{{/code}}. Leaving the field blank is equivalent to ##UNKWOWN## value.
... ... @@ -36,11 +36,11 @@
36 36  
37 37  Now we can define our hello macro as shown below:
38 38  
39 -{{image reference="macro1.png"/}}
39 +{{image reference="macro1.png" width="650px"/}}
40 40  
41 41  == Invocation ==
42 42  
43 -A wiki macro can be invoked just like any other macro is invoked. Since we are writing a xwiki/2.0 wiki macro, we can invoke our **hello macro** as below:
43 +A wiki macro can be invoked just like any other macro is invoked. Since we are writing a xwiki/2.1 wiki macro, we can invoke our **hello macro** as below:
44 44  
45 45  {{code language="none"}}
46 46  {{hello/}}
... ... @@ -51,15 +51,13 @@
51 51  == Content ==
52 52  
53 53  {{version since="11.4RC1"}}
54 -There are two ways to insert the content of the wiki macro.
54 +The easiest way to insert the content of the wiki macro is to use a dedicated macro in the body of the wikimacro:
55 55  
56 -* The easiest way is to use a dedicated macro in the body of the wikimacro:(((
57 57  {{code language='none'}}
58 58  {{wikimacrocontent/}}
59 59  {{/code}}
60 60  
61 61  Note that by default this makes the content of the macro directly editable in [[the WYSIWYG editor>>https://extensions.xwiki.org/xwiki/bin/view/Extension/CKEditor%20Integration/#HWikiMacros]].
62 -)))
63 63  {{/version}}
64 64  
65 65  For more details, see the [[Scripting Tips section below>>||anchor="HScriptingTips"]].
... ... @@ -150,15 +150,15 @@
150 150  
151 151  = Bindings =
152 152  
153 -See all availalbe bindings in [[the reference documentation page>>doc:extensions:Extension.WikiMacroStore.WebHome||anchor="HBindings"]].
151 +See all available bindings in [[the reference documentation page>>doc:extensions:Extension.WikiMacroStore.WebHome||anchor="HBindings"]].
154 154  
155 155  = WYSIWYG Access =
156 156  
157 157  A wiki macros is treated just like any other rendering macro in the system. As such, the moment you save your wiki macro it will be available to the users through the WYSIWYG editor's **Insert Macro** dialog box:
158 158  
159 -[[image:macro2.png]]
157 +[[image:macro2.png||height="293" width="350"]]
160 160  
161 -[[image:macro4.png]]
159 +[[image:macro4.png||height="149" width="350"]]
162 162  
163 163  == Special code for WYSIWYG edit mode ==
164 164  
... ... @@ -234,7 +234,7 @@
234 234  This pitfall has been fixed in XWiki 2.2
235 235  {{/info}}
236 236  
237 -There is a common pitfall for using optional paramters. The following macro code contains a not so obvious bug:
235 +There is a common pitfall for using optional parameters. The following macro code contains a not so obvious bug:
238 238  
239 239  {{code languege="velocity"}}
240 240  {{velocity}}
... ... @@ -244,6 +244,7 @@
244 244  #else
245 245   Hello world!
246 246  #end
245 +{{/velocity}}
247 247  {{/code}}
248 248  
249 249  If we invoke it twice in a row:
macro1.png
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.mleduc
Size
... ... @@ -1,1 +1,1 @@
1 -117.1 KB
1 +83.5 KB
Content
macro2.png
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.surli
1 +XWiki.mleduc
Size
... ... @@ -1,1 +1,1 @@
1 -15.7 KB
1 +24.8 KB
Content

Get Connected