Changes for page Macros

Last modified by Martin Výlet on 19.03.2025 21:26

From version 4.1
edited by Martin Výlet
on 19.03.2025 21:26
Change comment: Install extension [org.xwiki.platform:xwiki-platform-help-ui/17.1.0]
To version 2.1
edited by Administrator
on 05.09.2017 14:09
Change comment: Install extension [org.xwiki.contrib:application-help-center/1.2]

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -$services.localization.render('help.macros.title')
1 +Macros
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.vyl0022
1 +XWiki.xwikiadm
Content
... ... @@ -9,90 +9,101 @@
9 9   #end
10 10   #set ($browseMacrosURL = $xwiki.getURL('XWiki.XWikiPreferences', 'admin', "section=${section}&search=macro&repo="))
11 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')
12 + #set ($browseMacrosURL = 'http://extensions.xwiki.org/xwiki/bin/view/Extension/#%7Ct=extensions&p=1&l=30&s=doc.creationDate&d=desc&category=macro')
13 13  #end
14 14  
15 15  #set ($actionCards = [{
16 - 'title': $services.localization.render('help.macros.useMacros.title'),
17 - 'description': $services.localization.render('help.macros.useMacros.description'),
18 - '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')]),
16 + 'title': 'Use Macros',
17 + 'description': 'Macros are reusable pieces of functionality that can be integrated inside pages.',
18 + 'tip': "The <a href=""http://extensions.xwiki.org/xwiki/bin/view/Extension/CKEditor+Integration"" class=""wikiexternallink"">WYSIWYG Editor</a> allows you to insert macros and to customize their parameters when editing pages. Look for the $services.icon.renderHTML('cog') button on the tool bar.",
19 19   'thumbnail': 'Macro',
20 20   'actions': [{
21 - 'label': $services.localization.render('help.try.label'),
21 + 'label': 'Try it!',
22 22   'type': 'success',
23 23   'url': $xwiki.getURL('Sandbox.TestPage1', 'edit', 'editor=wysiwyg')
24 24   }]
25 25  }, {
26 - 'title': $services.localization.render('help.macros.browseMacros.title'),
27 - 'description': $services.localization.render('help.macros.browseMacros.description'),
28 - '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>']),
26 + 'title': 'Browse Macros',
27 + 'description': 'Choose from community contributed macros and install them inside your wiki.',
28 + 'tip': "The <a href=""#if($xwiki.exists('XWiki.XWikiSyntaxMacrosList'))$xwiki.getURL('XWiki.XWikiSyntaxMacrosList')#{else}$xwiki.getURL('XWiki.WikiMacros')#end"">Macro Index</a> lists the macros that are already installed and ready to be used inside your pages.",
29 29   'thumbnail': 'EM',
30 30   'actions': [{
31 - 'label': $services.localization.render('help.browse.label'),
31 + 'label': 'Browse',
32 32   'url': $browseMacrosURL
33 33   }, {
34 - 'label': $services.localization.render('help.more.label'),
35 - 'url': 'https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/WritingMacros/WikiMacroTutorial/'
34 + 'label': 'Learn more',
35 + 'url': 'http://platform.xwiki.org/xwiki/bin/view/DevGuide/WikiMacroTutorial'
36 36   }]
37 37  }])
38 38  
39 39  #set ($exampleCards = [{
40 - 'title': $services.localization.render('help.macros.box.title'),
41 - 'description': $services.localization.render('help.macros.box.description'),
42 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Box+Macro',
40 + 'title': 'Box',
41 + 'description': 'Displays a message in a styled box.',
42 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/Box+Macro',
43 43   'examples': 'Help.Macros.Box.WebHome',
44 44   'thumbnail': 'Help.Macros.Box.WebHome@box.png'
45 45  }, {
46 - 'title': $services.localization.render('help.macros.toc.title'),
47 - 'description': $services.localization.render('help.macros.toc.description'),
48 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/TOC+Macro',
46 + 'title': 'Table of Contents',
47 + 'description': 'Generates a table of contents for the page headings.',
48 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/TOC+Macro',
49 49   'examples': 'Help.Macros.ToC.WebHome',
50 50   'thumbnail': 'Help.Macros.ToC.WebHome@toc.png'
51 51  }, {
52 - 'title': $services.localization.render('help.macros.gallery.title'),
53 - 'description': $services.localization.render('help.macros.gallery.description'),
54 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery+Macro',
52 + 'title': 'Gallery',
53 + 'description': 'Displays a list of images in a slide-show gallery.',
54 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/Gallery+Macro',
55 55   'examples': 'Help.Macros.Gallery.WebHome',
56 56   'thumbnail': 'Help.Macros.Gallery.WebHome@gallery.png'
57 57  }, {
58 - 'title': $services.localization.render('help.macros.chart.title') ,
59 - 'description': $services.localization.render('help.macros.chart.description'),
60 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart+Macro',
58 + 'title': 'Chart',
59 + 'description': 'Generates graphical charts from data sources.',
60 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/Chart+Macro',
61 61   'examples': 'Help.Macros.Chart.WebHome',
62 62   'thumbnail': 'Help.Macros.Chart.WebHome@chart.png'
63 63  }, {
64 - 'title': $services.localization.render('help.macros.tree.title') ,
65 - 'description': $services.localization.render('help.macros.tree.description'),
66 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Document+Tree+Macro',
64 + 'title': 'Page Tree',
65 + 'description': 'Displays the hierarchy of pages.',
66 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/Document+Tree+Macro',
67 67   'examples': 'Help.Macros.Tree.WebHome',
68 68   'thumbnail': 'Help.Macros.Tree.WebHome@tree.png'
69 69  }, {
70 - 'title': $services.localization.render('help.macros.notifications.title') ,
71 - 'description': $services.localization.render('help.macros.notifications.description'),
72 - 'documentation': 'https://extensions.xwiki.org/xwiki/bin/view/Extension/Notifications%20Application/#HNotificationsMacro',
73 - 'examples': 'Help.Macros.Notifications.WebHome',
74 - 'thumbnail': 'Help.Macros.Notifications.WebHome@notifications.png'
70 + 'title': 'Activity',
71 + 'description': 'Displays recent activities done on pages by the users.',
72 + 'documentation': 'http://extensions.xwiki.org/xwiki/bin/view/Extension/Activity+Macro',
73 + 'examples': 'Help.Macros.Activity.WebHome',
74 + 'thumbnail': 'Help.Macros.Activity.WebHome@activity.png'
75 75  }])
76 76  {{/velocity}}
77 77  
78 78  {{velocity}}
79 79  {{html clean="false"}}
80 -<ul class="card-list two-cols">
80 +<div class="row">
81 81   #foreach ($card in $actionCards)
82 - <li class="card">
82 + ## See http://getbootstrap.com/css/#grid-responsive-resets .
83 + #if ($foreach.index > 0 && $foreach.index % 2 == 0)
84 + <div class="clearfix visible-sm-block visible-md-block visible-lg-block"></div>
85 + #end
86 + <div class="col-xs-12 col-sm-6">
83 83   #helpActionCard($card)
84 - </li>
88 + </div>
85 85   #end
86 -</ul>
90 +</div>
87 87  <h3 id="HExamples">Examples</h3>
88 88  <p>Need help or confused with some of our macros? Check out their documentation and find out more about their functionality.</p>
89 -<ul class="card-list three-cols">
93 +<div class="row">
90 90   #foreach ($card in $exampleCards)
91 - <li class="card">
95 + ## See http://getbootstrap.com/css/#grid-responsive-resets .
96 + #if ($foreach.index > 0 && $foreach.index % 2 == 0)
97 + <div class="clearfix visible-sm-block "></div>
98 + #end
99 + #if ($foreach.index > 0 && $foreach.index % 3 == 0)
100 + <div class="clearfix visible-md-block visible-lg-block"></div>
101 + #end
102 + <div class="col-xs-12 col-sm-6 col-md-4">
92 92   #helpExampleCard($card)
93 - </li>
104 + </div>
94 94   #end
95 -</ul>
96 -<p><a href="https://extensions.xwiki.org/xwiki/bin/view/Main/#%7Ct=extensions&p=1&l=30&s=doc.creationDate&d=desc&category=macro" class="wikiexternallink">$services.localization.render('help.macros.more')</a></p>
106 +</div>
107 +<p><a href="http://extensions.xwiki.org/xwiki/bin/view/Main/#%7Ct=extensions&p=1&l=30&s=doc.creationDate&d=desc&category=macro" class="wikiexternallink">View more macros</a></p>
97 97  {{/html}}
98 98  {{/velocity}}