Changes for page Help

Last modified by Thomas Mortagne on 2021/11/09 15:58
From version 2.1
edited by Thomas Mortagne
on 2021/11/09 15:58
Change comment: Install extension [org.xwiki.platform:xwiki-platform-help-ui/13.9]
To version 1.1
edited by Thomas Mortagne
on 2016/08/04 16:49
Change comment: Install extension [org.xwiki.platform:xwiki-platform-help-ui-8.2.1]

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -$services.localization.render('help.title')
Hidden
... ... @@ -1,1 +1,1 @@
1 -false
1 +true
Content
... ... @@ -1,124 +1,0 @@
1 -{{include reference="Help.Code.VelocityMacros" /}}
2 -
3 -{{velocity output="false"}}
4 -#macro (display4Cards $cards)
5 - <div class="row">
6 - #foreach ($card in $cards)
7 - ## See http://getbootstrap.com/css/#grid-responsive-resets .
8 - #if ($foreach.index > 0 && $foreach.index % 2 == 0)
9 - <div class="clearfix visible-sm-block "></div>
10 - #end
11 - #if ($foreach.index > 0 && $foreach.index % 3 == 0)
12 - <div class="clearfix visible-md-block"></div>
13 - #end
14 - #if ($foreach.index > 0 && $foreach.index % 4 == 0)
15 - <div class="clearfix visible-lg-block"></div>
16 - #end
17 - <div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">
18 - #helpExampleCard($card)
19 - </div>
20 - #end
21 - </div>
22 -#end
23 -
24 -#set ($howToCards = [{
25 - 'icon': 'fa fa-support',
26 - 'title': $services.localization.render('help.start.title'),
27 - 'description': $services.localization.render('help.start.description'),
28 - 'documentation': "https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/?version=$escapetool.url($xwiki.version)"
29 -}, {
30 - 'icon': 'fa fa-play-circle',
31 - 'title': $services.localization.render('help.videos.title'),
32 - 'description': $services.localization.render('help.videos.description'),
33 - 'documentation': 'Help.Videos.WebHome'
34 -}])
35 -
36 -#if ($xwiki.exists('Help.History.WebHome'))
37 - #set ($historyURL = $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History'))
38 -#else
39 - ## We need to generate the page history because the Extension Manager doesn't import it.
40 - #set ($historyURL = $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
41 - 'content': $services.localization.render('help.history.version11.content'),
42 - 'comment': $services.localization.render('help.history.version11.comment'),
43 - 'form_token': $services.csrf.token,
44 - 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
45 - 'title': $services.localization.render('help.history.version21.title'),
46 - 'content': $services.localization.render('help.history.version21.content'),
47 - 'form_token': $services.csrf.token,
48 - 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
49 - 'title': $services.localization.render('help.history.version22.title'),
50 - 'content': $services.localization.render('help.history.version22.content',['**']),
51 - 'comment': $services.localization.render('help.history.version22.comment'),
52 - 'minorEdit': 1,
53 - 'form_token': $services.csrf.token,
54 - 'xredirect': $xwiki.getURL('Help.History.WebHome', 'save', $escapetool.url({
55 - 'content': "$services.localization.render('help.history.version31.content',['**']) $util.newline${util.newline} $services.localization.render('help.history.version31.content1')",
56 - 'form_token': $services.csrf.token,
57 - 'xredirect': $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History')
58 - }))
59 - }))
60 - }))
61 - })))
62 -#end
63 -
64 -#set ($featureCards = [{
65 - 'icon': 'fa fa-pencil',
66 - 'title': $services.localization.render('help.edit.title'),
67 - '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')'>"]),
68 - 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/PageEditing',
69 - 'examples': $xwiki.getURL('Sandbox.WebHome', 'edit', 'editor=wysiwyg')
70 -}, {
71 - 'icon': 'fa fa-file-text-o',
72 - 'title': $services.localization.render('help.templates.title'),
73 - 'description': $services.localization.render('help.templates.description'),
74 - 'documentation': 'Help.Templates.WebHome',
75 - 'examples': $xwiki.getURL('Help.Templates.WebHome', 'view', $NULL, 'HExamples')
76 -}, {
77 - 'icon': 'fa fa-file-excel-o',
78 - 'title': $services.localization.render('help.macros.title'),
79 - 'description': $services.localization.render('help.macros.description'),
80 - 'documentation': 'Help.Macros.WebHome',
81 - 'examples': $xwiki.getURL('Help.Macros.WebHome', 'view', $NULL, 'HExamples')
82 -}, {
83 - 'icon': 'fa fa-files-o',
84 - 'title': $services.localization.render('help.applications.title'),
85 - 'description': $services.localization.render('help.applications.description'),
86 - 'documentation': 'Help.Applications.WebHome',
87 - 'examples': $xwiki.getURL('Help.Applications.WebHome', 'view', $NULL, 'HExamples')
88 -}, {
89 - 'icon': 'fa fa-sitemap',
90 - 'title': $services.localization.render('help.organization.title'),
91 - 'description': $services.localization.render('help.organization.description'),
92 - 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/ContentOrganization/',
93 - 'examples': $xwiki.getURL('Main.AllDocs', 'view', 'view=tree')
94 -}, {
95 - 'icon': 'fa fa-history',
96 - 'title': $services.localization.render('help.history.title'),
97 - 'description': $services.localization.render('help.history.description'),
98 - 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/VersionControl',
99 - 'examples': $historyURL
100 -}, {
101 - 'icon': 'fa fa-download',
102 - 'title': $services.localization.render('help.import.title'),
103 - 'description': $services.localization.render('help.import.description'),
104 - 'documentation': 'https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/Imports'
105 -}])
106 -{{/velocity}}
107 -
108 -{{velocity}}
109 -= $services.localization.render('help.title1') =
110 -
111 -$services.localization.render('help.description1')
112 -
113 -{{html clean="false"}}
114 -#display4Cards($howToCards)
115 -{{/html}}
116 -
117 -= $services.localization.render('help.title2') =
118 -
119 -$services.localization.render('help.description2')
120 -
121 -{{html clean="false"}}
122 -#display4Cards($featureCards)
123 -{{/html}}
124 -{{/velocity}}
XWiki.UIExtensionClass[0]
Extension Point ID
... ... @@ -1,1 +1,0 @@
1 -org.xwiki.platform.panels.Applications
Extension Scope
... ... @@ -1,1 +1,0 @@
1 -wiki
Extension ID
... ... @@ -1,1 +1,0 @@
1 -platform.help
Extension Parameters
... ... @@ -1,3 +1,0 @@
1 -label=$services.localization.render('help.title')
2 -target=Help.WebHome
3 -icon=icon:help