Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -49,15 +49,16 @@
49	49
50	50	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 allows you to define your parameter clearly:
51	51
52		-* Parameter name:
	52	+* Parameter name: Name of the parameter, users will refer this name when invoking your macro with parameters
53	53
54		-* Parameter description:
	54	+* Parameter description: A short description of the parameter, this description will be made available on the WYSIWYG editor
55	55
56		-* Parameter mandatory:
	56	+* Parameter mandatory: Indicates if this particular parameter is mandatory, wiki macro will fail to execute if a mandatory parameter is missing
57	57
58	58	#error("This section is being updated")
59	59
60	60
	61	+
61	61	1.1 WYSIWYG Access
62	62
63	63	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: