Skip to Content

Wiki source code of Macros

Last modified by XWikiGuest on 2026/06/21 22:38
Show last authors
1 {{include reference="Help.Code.VelocityMacros" /}}
2
3 {{velocity output="false"}}
4 #if ($hasAdmin)
5 #set ($section = 'XWiki.Extensions')
6 #if (!$xwiki.exists($section))
7 ## Support for pre-9.2RC1 Administration Application
8 #set ($section = 'XWiki.AddExtensions')
9 #end
10 #set ($browseMacrosURL = $xwiki.getURL('XWiki.XWikiPreferences', 'admin', "section=${section}&search=macro&repo="))
11 #else
12 #set ($browseMacrosURL = 'https://extensions.xwiki.org/xwiki/bin/view/Extension/#%7Ct=extensions&p=1&l=30&s=doc.creationDate&d=desc&category=macro')
13 #end
14
15 #
16 code ($actionCards = [{
17 'title': $services.localization.render('help.macros.useMacros.title'),
18 'description': $services.localization.render('help.macros.useMacros.description'),
19 'tip':$services.localization.render('help.macros.useMacros.tip', ["<a href='https://extensions.xwiki.org/xwiki/bin/view/Extension/CKEditor+Integration' class='wikiexternallink'>",'</a>', $services.icon.renderHTML('cog')]),
20 'thumbnail': 'Macro',
21 'actions': [{
22 'label': $services.localization.render('help.try.label'),
23 'type': 'success',
24 'url': $xwiki.getURL('Sandbox.TestPage1', 'edit', 'editor=wysiwyg')
25 }]
26 }, {
27 'title': $services.localization.render('help.macros.browseMacros.title'),
28 'description': $services.localization.render('help.macros.browseMacros.description'),
29 'tip':': $services.localization.render('help.macros.browseMacros.tip', ["<a href='#if($xwiki.exists('XWiki.XWikiSyntaxMacrosList'))$xwiki.getURL('XWiki.XWikiSyntaxMacrosList')#{else}$xwiki.getURL('XWiki.WikiMacros')#end'>",'</a>']),
30 'thumbnail': 'EM',
31 'actions': [{
32 'label': $services.localization.render('help.browse.label'),
33 'url': $browseMacrosURL
34 }, {
35 'label': $services.localization.render('help.more.label'),
36 'url': 'https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/'
37 }]
38 }])
39
40
41 #set ($exampleCards = [{
42 'title': $services.localization.render('help.macros.box.title'),
43 'description': $services.localization.render('help.macros.box.description'),
44 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Box+Macro',
45 'examples': 'Help.Macros.Box.WebHome',
46 'thumbnail': 'Help.Macros.Box.WebHome@box.png'
47 }, {
48 'title': $services.localization.render('help.macros.toc.title'),
49 'description': $services.localization.render('help.macros.toc.description'),
50 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/TOC+Macro',
51 'examples': 'Help.Macros.ToC.WebHome',
52 'thumbnail': 'Help.Macros.ToC.WebHome@toc.png'
53 }, {
54 'title': $services.localization.render('help.macros.gallery.title'),
55 'description': $services.localization.render('help.macros.gallery.description'),
56 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery+Macro',
57 'examples': 'Help.Macros.Gallery.WebHome',
58 'thumbnail': 'Help.Macros.Gallery.WebHome@gallery.png'
59 }, {
60 'title': $services.localization.render('help.macros.chart.title') ,
61 'description': $services.localization.render('help.macros.chart.description'),
62 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart+Macro',
63 'examples': 'Help.Macros.Chart.WebHome',
64 'thumbnail': 'Help.Macros.Chart.WebHome@chart.png'
65 }, {
66 'title': $services.localization.render('help.macros.tree.title') ,
67 'description': $services.localization.render('help.macros.tree.description'),
68 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Document+Tree+Macro',
69 'examples': 'Help.Macros.Tree.WebHome',
70 'thumbnail': 'Help.Macros.Tree.WebHome@tree.png'
71 }, {
72 'title': $services.localization.render('help.macros.notifications.title') ,
73 'description': $services.localization.render('help.macros.notifications.description'),
74 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Application/#HNotificationsMacro',
75 'examples': 'Help.Macros.Notifications.WebHome',
76 'thumbnail': 'Help.Macros.Notifications.WebHome@notifications.png'
77 }])
78 {{/velocity}}
79
80 {{velocity}}
81 {{html clean="false"}}
82 <ul class="card-list two-cols">
83 #foreach ($card in $actionCards)
84 <li class="card">
85 #helpActionCard($card)
86 </li>
87 #end
88 </ul>
89 <h3 id="HExamples">Examples</h3>
90 <p>Need help or confused with some of our macros? Check out their documentation and find out more about their functionality.</p>
91 <ul class="card-list three-cols">
92 #foreach ($card in $exampleCards)
93 <li class="card">
94 #helpExampleCard($card)
95 </li>
96 #end
97 </ul>
98 <p><a href="https://extensions.xwiki.org/xwiki/bin/view/Main/#%7Ct=extensions&p=0&l=30&s=doc.creationDate&d=desc&category=macro" class="wikiexternallink">$services.localization.render('help.macros.more')</a></p>
99 {{/html}}
100 {{/velocity}}