Skip to Content

Wiki source code of Help

Last modified by SuperNico Laub on 2025/09/18 16:59
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.version11.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', 'save', $escapetool.url({
45 'content': "$services.localization.render('help.history.version31.content',['**']) $util.newline${util.newline} $services.localization.render('help.history.version31.content1')",
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',
56 'title': $services.localization.render('help.edit.title'),
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',
59 'examples': $xwiki.getURL('Sandbox.WebHome', 'edit', 'editor=wysiwyg')
60 }, {
61 'icon': 'fa fa-file-text-o',
62 'title': $services.localization.render('help.templates.title'),
63 'description': $services.localization.render('help.templates.description'),
64 'documentation': 'Help.Templates.WebHome',
65 'examples': $xwiki.getURL('Help.Templates.WebHome', 'view', $NULL, 'HExamples')
66 }, {
67 'icon': 'fa fa-file-excel-o',
68 'title': $services.localization.render('help.macros.title'),
69 'description': $services.localization.render('help.macros.description'),
70 'documentation': 'Help.Macros.WebHome',
71 'examples': $xwiki.getURL('Help.Macros.WebHome', 'view', $NULL, 'HExamples')
72 }, {
73 'icon': 'fa fa-files-o',
74 'title': $services.localization.render('help.applications.title'),
75 'description': $services.localization.render('help.applications.description'),
76 'documentation': 'Help.Applications.WebHome',
77 'examples': $xwiki.getURL('Help.Applications.WebHome', 'view', $NULL, 'HExamples')
78 }, {
79 'icon': 'fa fa-sitemap',
80 'title': $services.localization.render('help.organization.title'),
81 'description': $services.localization.render('help.organization.description'),
82 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/ContentOrganization/',
83 'examples': $xwiki.getURL('Main.AllDocs', 'view', 'view=tree')
84 }, {
85 'icon': 'fa fa-history',
86 'title': $services.localization.render('help.history.title'),
87 'description': $services.localization.render('help.history.description'),
88 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/VersionControl',
89 'examples': $historyURL
90 }, {
91 'icon': 'fa fa-download',
92 'title': $services.localization.render('help.import.title'),
93 'description': $services.localization.render('help.import.description'),
94 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/Imports'
95 }])
96 {{/velocity}}
97
98 {{velocity}}
99 = $services.localization.render('help.title1') =
100
101 $services.localization.render('help.description1')
102
103 {{html clean="false"}}
104 #display4Cards($howToCards)
105 {{/html}}
106
107 = $services.localization.render('help.title2') =
108
109 $services.localization.render('help.description2')
110
111 {{html clean="false"}}
112 #display4Cards($featureCards)
113 {{/html}}
114 {{/velocity}}