Wiki source code of Writing XWiki Rendering Macros in wiki pages
Last modified by slauriere on 2024/09/17
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | Wiki macros allow macro authors to develop reusable and distributable macro modules. There is no java code involved; hence no compiling or packaging. The macro author simply needs to create a wiki page according to a particular specification and that's all! | ||
| 6 | |||
| 7 | This page is a tutorial but you can also access the [[reference documentation for the Wiki Macro feature>>doc:extensions:Extension.WikiMacroStore.WebHome]]. | ||
| 8 | |||
| 9 | = Hello Macro = | ||
| 10 | |||
| 11 | We are going to start with a very simple xwiki/2.0 wiki macro which prints a greeting message to the document content. It isn't a very useful macro but the idea is to get you familiarised with the wiki macro creation process. | ||
| 12 | |||
| 13 | == Definition == | ||
| 14 | |||
| 15 | 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##. You will need to [[be advanced>>Documentation.UserGuide.Features.PageEditing||anchor="HAdvancedProfile"]] to access the [[object editor>>Documentation.UserGuide.Features.PageEditing||anchor="HObjectseditingmode"]]. | ||
| 16 | |||
| 17 | {{warning}} | ||
| 18 | There can be only one object of type ##XWiki.WikiMacroClass## per wiki page (if you add more only the first will be used). | ||
| 19 | {{/warning}} | ||
| 20 | |||
| 21 | This class contains the following fields: | ||
| 22 | |||
| 23 | * **Macro id**: Id of the macro to be used by users when invoking your macro from wiki code | ||
| 24 | * **Macro name**: Name of the macro to be displayed on the wysiwyg editor | ||
| 25 | * **Macro description**: A short description of the macro to be displayed on the WYSIWYG editor | ||
| 26 | * {{version since="14.4RC1"}}**Default categories**: Default categories under which this macro should be listed{{/version}} ({{version before="14.4RC1"}}It was called "Default category"{{/version}}) | ||
| 27 | ** A list of [[default categories used is available>>Documentation.DevGuide.Tutorials.WritingMacros.MacroDefaultCategories.WebHome]]. | ||
| 28 | * **Supports inline mode**: Whether the macro can be used in an inline context or not | ||
| 29 | * **Macro content availability**: Whether this macro should support a body or not. Valid values are "Optional", "Mandatory" and "No Content". | ||
| 30 | * **Macro content type**: 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. | ||
| 31 | * **Content description**: A short description about the macro's content to be displayed on the WYSIWYG editor | ||
| 32 | * **Macro code**: The actual wiki code that will be evaluated when the macro is executed, can be any xwiki content (should be in the same syntax as the document) | ||
| 33 | * **Priority**: The priority of execution relative to the other Macros. The lowest values have the highest priorities and execute first. For example a Macro with a priority of 100 will execute before one with a priority of 500. The default value is 1000. | ||
| 34 | * **Asynchronous rendering**: Enabled or disable asynchronous rendering of the macro. Disabled by default. | ||
| 35 | * **Cached**: Indicate if the result of the execution of the element should be cached. Disabled by default. | ||
| 36 | * **Context elements**: The context information required during the execution of the extension (current user, current document, etc.). It's also used to generate the cache key. | ||
| 37 | |||
| 38 | Now we can define our hello macro as shown below: | ||
| 39 | |||
| 40 | {{image reference="macro1.png" width="650px"/}} | ||
| 41 | |||
| 42 | == Invocation == | ||
| 43 | |||
| 44 | 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: | ||
| 45 | |||
| 46 | {{code language="none"}} | ||
| 47 | {{hello/}} | ||
| 48 | {{/code}} | ||
| 49 | |||
| 50 | And if you view the result it would say "Hello World!" (of course). | ||
| 51 | |||
| 52 | == Content == | ||
| 53 | |||
| 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 | |||
| 56 | {{code language='none'}} | ||
| 57 | {{wikimacrocontent/}} | ||
| 58 | {{/code}} | ||
| 59 | |||
| 60 | 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]]. | ||
| 61 | |||
| 62 | For more details, see the [[Scripting Tips section below>>||anchor="HScriptingTips"]]. | ||
| 63 | |||
| 64 | == Parameters == | ||
| 65 | |||
| 66 | 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: | ||
| 67 | |||
| 68 | * **Parameter name**: Name of the parameter, users will refer this name when invoking your macro with parameters | ||
| 69 | * **Parameter description** (optional): A short description of the parameter, this description will be made available on the WYSIWYG editor | ||
| 70 | * **Parameter mandatory**: Indicates if this particular parameter is mandatory, wiki macro will fail to execute if a mandatory parameter is missing | ||
| 71 | * **Parameter default value** (optional): The default value of the parameter when it's empty | ||
| 72 | * **Parameter type** (optional): Indicates to which Java type the parameter value (defined as a String). Two values are proposed, ##WIKI## if this parameter contains 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. | ||
| 73 | ** This is needed when using the ##{~{wikimacroparameter}}## macro (see below), which uses this type to decide how to render the macro parameter. | ||
| 74 | ** For more information about parameter types and parameter pickers, see: [[Using pickers for XWiki Rendering Macro parameters>>Documentation.DevGuide.Tutorials.WritingMacros.Using custom pickers for XWiki Rendering Macro parameters.WebHome]] | ||
| 75 | |||
| 76 | Now we're going to extend our **hello macro** with a parameter. We will introduce a parameter named //greetUser// that will indicate if the greeting message should be tailored for the current user viewing the page. The definition of the parameter is shown below: | ||
| 77 | |||
| 78 | [[image:macro3.png]] | ||
| 79 | |||
| 80 | A macro parameter defined this way can be accessed from any scripting language within the macro code. For example, we are going to utilize our //greetUser// parameter within **hello macro** as shown below: | ||
| 81 | |||
| 82 | {{code language="none"}} | ||
| 83 | {{velocity}} | ||
| 84 | #if ($wikimacro.parameters.greetUser && "XWiki.XWikiGuest" != "$xcontext.user") | ||
| 85 | Hello $services.rendering.escape($xwiki.user.email, 'xwiki/2.1')! | ||
| 86 | #else | ||
| 87 | Hello world! | ||
| 88 | #end | ||
| 89 | {{/velocity}} | ||
| 90 | {{/code}} | ||
| 91 | |||
| 92 | As you might have realized already, direct binding of parameters is not supported at the moment. That is, you cannot access //greetUser// parameter with **$greetUser**. Instead you must use **$wikimacro.parameters.greetUser**. We plan to introduce some form of direct parameter binding in the future. | ||
| 93 | |||
| 94 | It is also possible to display the content of a macro parameter by using a dedicated macro: | ||
| 95 | |||
| 96 | {{code language="none"}}Hello {{wikimacroparameter name="greetUsers" /}}{{/code}} | ||
| 97 | |||
| 98 | Finally, we can test our new version of **hello macro** with the following invocation: | ||
| 99 | |||
| 100 | {{code language="none"}} | ||
| 101 | {{hello greetUser="true"/}} | ||
| 102 | {{/code}} | ||
| 103 | |||
| 104 | If you want to call the new version of the **hello macro** with a parameter from a variable you will need to wrap the call in a velocity macro like this: | ||
| 105 | |||
| 106 | {{code language="none"}} | ||
| 107 | {{velocity}} | ||
| 108 | #set ($greet = true) | ||
| 109 | {{hello greetUser="$greet"/}} | ||
| 110 | {{/velocity}} | ||
| 111 | {{/code}} | ||
| 112 | |||
| 113 | == Translations == | ||
| 114 | |||
| 115 | When your macro is ready, you might want to provide the description of the macro and its parameters in different languages. For that, you need to create a set of translation keys and values (as described [[here>>xwiki:Documentation.DevGuide.InternationalizingApplications]]) and then just use the following convention for the keys you add in this storage (no modification is needed on the macro itself, the association of the translations to the macro is done based on a convention of the form of the translation keys): | ||
| 116 | |||
| 117 | {{code language="properties"}} | ||
| 118 | rendering.macro.<macro id>.name=Name of the macro, displayed in the macros list in the macros wizard | ||
| 119 | rendering.macro.<macro id>.description=Description of the macro, displayed as a help in the macros list in the macros wizard | ||
| 120 | |||
| 121 | rendering.macro.<macro id>.parameter.<parameter name>.name=Name of the macro parameter, to be displayed in the form for the macro settings in the macros wizard | ||
| 122 | rendering.macro.<macro id>.parameter.<parameter name>.description=Description of the macro parameter, to be displayed as a help in the form for the macro settings in the macros wizard | ||
| 123 | {{/code}} | ||
| 124 | |||
| 125 | Don't forget to make sure that the visibility of the translations is the same as the visibility of the macro, so that anywhere you use the macro you also have the translations. | ||
| 126 | |||
| 127 | In our example, french translations would be something like this: | ||
| 128 | |||
| 129 | {{code language="properties"}} | ||
| 130 | rendering.macro.hello.name=Macro pour dire bonjour | ||
| 131 | rendering.macro.hello.description=Ceci est une macro qui va dire "Bonjour" a l'utilisateur | ||
| 132 | rendering.macro.hello.parameter.greetUser.name=Personnaliser le message | ||
| 133 | rendering.macro.hello.parameter.greetUser.description=Personnaliser le message pour l'utilisateur courant en train de visualiser la page. Les valeurs possibles sont "true" (oui) et "false" (non). | ||
| 134 | {{/code}} | ||
| 135 | |||
| 136 | = Macro Visibility and Rights = | ||
| 137 | |||
| 138 | There are 3 levels of visibility for a macro: | ||
| 139 | |||
| 140 | * ##Global## | ||
| 141 | ** on the main wiki, the macro will be available in all the pages of all the (sub)wikis. Requires the macro author to have **Programming Rights** | ||
| 142 | ** on subwikis, it's a synonym of the ##Current Wiki## visibility | ||
| 143 | * ##Current Wiki##, which means that the macro will be available in all the pages of the wiki the macro is in. Requires the macro author to have **Admin Rights** | ||
| 144 | * ##Current User##, which means that the macro will only be available to the user who is its author. No special rights required. | ||
| 145 | |||
| 146 | == Using protected API in wiki macros == | ||
| 147 | |||
| 148 | Also, if the macro needs to use [[protected API>>xwiki:Documentation.DevGuide.Scripting||anchor="HXWikiCoreAccess"]], the author of the macro will need to have programming rights. Note that the macro will always be executed with the rights of its author, and not with the rights of the author of the calling document (the document using the macro). Specifically, if the macro uses protected API, only the macro author needs to have programming rights, not all the authors of the documents that call this macro. | ||
| 149 | |||
| 150 | = Bindings = | ||
| 151 | |||
| 152 | The usual XWiki [[scripting context bindings>>doc:extensions:Extension.Script Macro||anchor="HBindings"]] are available in the scripts of the wiki macros, with the mention that contextual variables (such as ##$doc##) will point to the XWiki document (page) in which the macro is called, not to the XWiki document containing the objects that define the macro. This makes it easy to write features that are contextualized to the page where they're called. | ||
| 153 | |||
| 154 | Then, specific bindings for the wiki macro context are available, see [[the reference documentation page>>doc:extensions:Extension.WikiMacroStore.WebHome||anchor="HBindings"]]. | ||
| 155 | |||
| 156 | = WYSIWYG Access = | ||
| 157 | |||
| 158 | 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: | ||
| 159 | |||
| 160 | [[image:macro2.png||height="293" width="350"]] | ||
| 161 | |||
| 162 | [[image:macro4.png||height="149" width="350"]] | ||
| 163 | |||
| 164 | == Special code for WYSIWYG edit mode == | ||
| 165 | |||
| 166 | Even in edit mode, the WYSIWYG editor will execute the macro and feed the result back into the document. If your macro use some JSX, these will not be loaded. But, if your macro produce some Javascript that use those JSX or manipulate the document's DOM (injecting new elements, moving existing elements, removing elements, etc.), you may want to protect the content in WYSIWYG edit mode in order to prevent the performed transformation to get saved. Here is how you can prevent this behavior: | ||
| 167 | |||
| 168 | {{code language="velocity"}} | ||
| 169 | {{velocity}} | ||
| 170 | #if("$xcontext.action" != "edit") | ||
| 171 | {{html}} | ||
| 172 | <script type="text/javascript"> | ||
| 173 | //<![CDATA[ | ||
| 174 | ... some javascript ... | ||
| 175 | // ]]> | ||
| 176 | </script> | ||
| 177 | {{/html}} | ||
| 178 | #end | ||
| 179 | ## | ||
| 180 | ## Rest of the code. | ||
| 181 | {{/velocity}} | ||
| 182 | {{/code}} | ||
| 183 | |||
| 184 | == WYSIWYG editing of macro content or parameter == | ||
| 185 | |||
| 186 | As specified above you can use the dedicated macros {{code language="none"}}{{wikimacrocontent/}}{{/code}} and {{code language="none"}}{{wikimacroparameter name="foo"/}}{{/code}} to allow the users of your macro to be able to edit the values of the macro directly in the WYSIWYG editor once the macro is inserted. | ||
| 187 | Note that this is currently only possible if you specified that the macro content (or parameter) type is ##WIKI## type. | ||
| 188 | |||
| 189 | {{info}} | ||
| 190 | There is also a known limitation related to CKEditor that prevents editing directly those macros if they are not used as "standalone" macro. Details can be found on the [[related issue>>https://jira.xwiki.org/browse/CKEDITOR-248]]. | ||
| 191 | {{/info}} | ||
| 192 | |||
| 193 | = Scripting Tips = | ||
| 194 | |||
| 195 | Following are a few useful hints if you plan to do advanced scripting inside your wiki macros: | ||
| 196 | |||
| 197 | * It's possible to directly return the desired list of rendering blocks without having to render them first to let them be parsed back by the macro transformation. The benefits are that it could be a lots quicker and most of all it means supporting syntax which does not provide any renderer. It also makes it possible to generate some XDOM which is impossible to write in any some syntax. For example the following wiki macro is generating a LinkBlock targeting a relative URL:((( | ||
| 198 | {{code language="groovy"}} | ||
| 199 | {{groovy}} | ||
| 200 | import java.util.Collections; | ||
| 201 | import org.xwiki.rendering.listener.Link; | ||
| 202 | import org.xwiki.rendering.block.WordBlock; | ||
| 203 | import org.xwiki.rendering.block.LinkBlock; | ||
| 204 | |||
| 205 | ref link = new Link(); | ||
| 206 | link.setReference("/xwiki/edit/Main/WebHome"); | ||
| 207 | link.setType(LinkType.URI); | ||
| 208 | |||
| 209 | ref linkBlock = new LinkBlock(Collections.singletonList(new WordBlock("Edit home page"))), link, false); | ||
| 210 | |||
| 211 | wikimacro.result = Collections.singletonList(linkBlock) | ||
| 212 | {{/groovy}} | ||
| 213 | |||
| 214 | This text will not appear in the result. | ||
| 215 | {{/code}} | ||
| 216 | ))) | ||
| 217 | * If you need to directly access the parsed XDOM of the content you may do the parsing yourself using the rendering service. Here is a small sample:((( | ||
| 218 | {{code language="velocity"}} | ||
| 219 | {{velocity output="no"}} | ||
| 220 | ## get the macro content in a velocity string | ||
| 221 | #set($wikiresult = $wikimacro.content) | ||
| 222 | ## Add a wrapping div as a sample of the action of this macro | ||
| 223 | #set($wikiresult = "(% class='newstyle' %)((($wikiresult)))") | ||
| 224 | ## parse the string and return the resulting blocks | ||
| 225 | #set($wikimacro.result = $services.rendering.parse($wikiresult, $xwiki.getCurrentContentSyntaxId()).getChildren()) | ||
| 226 | {{/velocity}} | ||
| 227 | {{/code}} | ||
| 228 | ))) |
