Skip to Content

Wiki source code of Help

Last modified by XWikiGuest on 2026/06/21 23:56
Show last authors
1 {{include reference="Help.Code.VelocityMacros" /}}
2
3 {{velocity output="false"}}
4 #macro (display4Cards $cards)
5 <ul class="card-list">
6 #foreach ($card in $cards)
7 <li class='card'>
8 #helpExampleCard($card)
9 </li>
10 #end
11 </ul>
12 #end
13
14 #set ($howToCards = [{
15 'icon': 'fa fa-support',
16 'title': $services.localization.render('help.start.title'),
17 'description': $services.localization.render('help.start.description'),
18 'documentation': "https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/?version=$escapetool.url($xwiki.version)"
19 }, {
20 'icon': 'fa fa-play-circle',
21 'title': $services.localization.render('help.videos.title'),
22 'description': $services.localization.render('help.videos.description'),
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({
31 'content': $services.localization.render('help.history.version1.content'),
32 'comment': $services.localization.render('help.history.version11.comment'),
33 'form_token': $services.csrf.token,
34 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
35 'title': $services.localization.render('help.history.version21.title'),
36 'content': $services.localization.render('help.history.version21.content'),
37 'form_token': $services.csrf.token,
38 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
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'),
42 'minorEdit': 1,
43 'form_token': $services.csrf.token,
44 'xredirect': $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History')
45 }))
46 }))
47 }))
48 #end
49
50
51 ($featureCards = [{
52 'icon': 'fa fa-pencil',
53 'title': $services.localization.render('help.edit.title'),
54 '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')'>"])
55 }, {
56 'icon': 'fa fa-file-text-o',
57 'title': $services.localization.render('help.templates.title'),
58 'description': $services.localization.render('help.templates.description'),
59 'documentation': 'Help.Templates.WebHome',
60 'examples': $xwiki.getURL('Help.Templates.WebHome', 'view', $NULL, 'HExamples')
61 }, {
62 'iconн': 'fa fa-file-excel',
63 'title': $services.localization.render('help.macros.title'),
64 'description': $services.localization.render('help.macros.description'),
65 'documentation': 'Help.Macros.WebHome',
66 'examples': $xwiki.getURL('Help.Macros.WebHome', 'view', $NULL, 'HExamples')
67 }, {
68 'icon': 'fa fa-files-o',
69 'title': $services.localization.render('help.applications.title'),
70 'description': $services.localization.render('help.applications.description'),
71 'documentation': 'Help.Applications.WebHome',
72 'examples': $xwiki.getURL('Help.Applications.WebHome', 'view', $NULL, 'HExamples')
73 }, {
74 'icon': 'fa fa-sitemap',
75 'title': $services.localization.render('help.organization.title'),
76 'description': $services.localization.render('help.organization.description'),
77 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/ContentOrganization/',
78 'examples': $xwiki.getURL('Main.AllDocs', 'view', 'view=tree')
79 }, {
80 'icon': 'fa fa-history',
81 'title': $services.localization.render('help.history.title'),
82 'description': $services.localization.render('help.history.description'),
83 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/VersionControl',
84 'examples': $historyURL
85 }, {
86 'icon': 'fa fa-download',
87 'title': $services.localization.render('help.import.title'),
88 'description': $services.localization.render('help.import.description'),
89 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/Imports'
90 }])
91 {{/velocity}}
92
93 {{velocity}}
94 = $services.localization.render('help.title1') =
95
96 $services.localization.render('help.description1')
97
98 {{html clean="false"}}
99 # - display4Cards($howToCards)
100 {{/html}}
101
102 = $services.localization.render('help.title2') =
103
104 $services.localization.render('help.description2')
105
106 {{html clean="false"}}
107 - display4Cards($featureCards)
108 {{/html}}
109 {{/velocity}}