Skip to Content

Wiki source code of Help

Last modified by Administrator on 2026/02/17 22:15
Hide last authors
Administrator 1.1 1 {{include reference="Help.Code.VelocityMacros" /}}
2
3 {{velocity output="false"}}
4 #macro (display4Cards $cards)
Administrator 6.1 5 <ul class="card-list">
Administrator 1.1 6 #foreach ($card in $cards)
Administrator 6.1 7 <li class='card'>
Administrator 1.1 8 #helpExampleCard($card)
Administrator 6.1 9 </li>
Administrator 1.1 10 #end
Administrator 6.1 11 </ul>
Administrator 1.1 12 #end
13
14 #set ($howToCards = [{
15 'icon': 'fa fa-support',
Administrator 3.1 16 'title': $services.localization.render('help.start.title'),
17 'description': $services.localization.render('help.start.description'),
Administrator 4.1 18 'documentation': "https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/?version=$escapetool.url($xwiki.version)"
Administrator 1.1 19 }, {
20 'icon': 'fa fa-play-circle',
Administrator 3.1 21 'title': $services.localization.render('help.videos.title'),
22 'description': $services.localization.render('help.videos.description'),
Administrator 1.1 23 'documentation': 'Help.Videos.WebHome'
24 }])
25
26 #if ($xwiki.exists('Help.History.WebHome'))
27 #set ($historyURL = $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History'))
28 #else
29 ## We need to generate the page history because the Extension Manager doesn't import it.
30 #set ($historyURL = $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
Administrator 3.1 31 'content': $services.localization.render('help.history.version11.content'),
32 'comment': $services.localization.render('help.history.version11.comment'),
Administrator 1.1 33 'form_token': $services.csrf.token,
34 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
Administrator 3.1 35 'title': $services.localization.render('help.history.version21.title'),
36 'content': $services.localization.render('help.history.version21.content'),
Administrator 1.1 37 'form_token': $services.csrf.token,
38 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
Administrator 3.1 39 'title': $services.localization.render('help.history.version22.title'),
40 'content': $services.localization.render('help.history.version22.content',['**']),
41 'comment': $services.localization.render('help.history.version22.comment'),
Administrator 1.1 42 'minorEdit': 1,
43 'form_token': $services.csrf.token,
44 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
Administrator 3.1 45 'content': "$services.localization.render('help.history.version31.content',['**']) $util.newline${util.newline} $services.localization.render('help.history.version31.content1')",
Administrator 1.1 46 'form_token': $services.csrf.token,
47 'xredirect': $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History')
48 }))
49 }))
50 }))
51 })))
52 #end
53
54 #set ($featureCards = [{
55 'icon': 'fa fa-pencil',
Administrator 3.1 56 'title': $services.localization.render('help.edit.title'),
Administrator 5.1 57 'description': $services.localization.render('help.edit.description',["<a href='https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/PageEditing' class='wikiexternallink'>",'</a>',"<a href='$xwiki.getURL('XWiki.XWikiSyntax')'>"]),
58 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/PageEditing',
Administrator 1.1 59 'examples': $xwiki.getURL('Sandbox.WebHome', 'edit', 'editor=wysiwyg')
60 }, {
61 'icon': 'fa fa-file-text-o',
Administrator 3.1 62 'title': $services.localization.render('help.templates.title'),
63 'description': $services.localization.render('help.templates.description'),
Administrator 1.1 64 'documentation': 'Help.Templates.WebHome',
65 'examples': $xwiki.getURL('Help.Templates.WebHome', 'view', $NULL, 'HExamples')
66 }, {
67 'icon': 'fa fa-file-excel-o',
Administrator 3.1 68 'title': $services.localization.render('help.macros.title'),
69 'description': $services.localization.render('help.macros.description'),
Administrator 1.1 70 'documentation': 'Help.Macros.WebHome',
71 'examples': $xwiki.getURL('Help.Macros.WebHome', 'view', $NULL, 'HExamples')
72 }, {
73 'icon': 'fa fa-files-o',
Administrator 3.1 74 'title': $services.localization.render('help.applications.title'),
75 'description': $services.localization.render('help.applications.description'),
Administrator 1.1 76 'documentation': 'Help.Applications.WebHome',
77 'examples': $xwiki.getURL('Help.Applications.WebHome', 'view', $NULL, 'HExamples')
78 }, {
79 'icon': 'fa fa-sitemap',
Administrator 3.1 80 'title': $services.localization.render('help.organization.title'),
81 'description': $services.localization.render('help.organization.description'),
Administrator 5.1 82 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/ContentOrganization/',
Administrator 1.1 83 'examples': $xwiki.getURL('Main.AllDocs', 'view', 'view=tree')
84 }, {
85 'icon': 'fa fa-history',
Administrator 3.1 86 'title': $services.localization.render('help.history.title'),
87 'description': $services.localization.render('help.history.description'),
Administrator 5.1 88 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/VersionControl',
Administrator 1.1 89 'examples': $historyURL
90 }, {
91 'icon': 'fa fa-download',
Administrator 3.1 92 'title': $services.localization.render('help.import.title'),
93 'description': $services.localization.render('help.import.description'),
Administrator 5.1 94 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/Imports'
Administrator 1.1 95 }])
96 {{/velocity}}
97
98 {{velocity}}
Administrator 3.1 99 = $services.localization.render('help.title1') =
Administrator 1.1 100
Administrator 3.1 101 $services.localization.render('help.description1')
Administrator 1.1 102
103 {{html clean="false"}}
104 #display4Cards($howToCards)
105 {{/html}}
106
Administrator 3.1 107 = $services.localization.render('help.title2') =
Administrator 1.1 108
Administrator 3.1 109 $services.localization.render('help.description2')
Administrator 1.1 110
111 {{html clean="false"}}
112 #display4Cards($featureCards)
113 {{/html}}
114 {{/velocity}}