Skip to Content

Changes for page Help

Last modified by Administrator on 2026/02/17 22:15
From version 6.1
edited by Administrator
on 2026/02/17 22:15
Change comment: Install extension [org.xwiki.platform:xwiki-platform-help-ui/17.10.3]
To version 1.1
edited by Administrator
on 2018/07/24 00:26
Change comment: Install extension [org.xwiki.contrib:application-help-center/1.2]

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -$services.localization.render('help.title')
Content
... ... @@ -2,24 +2,34 @@
2 2  
3 3  {{velocity output="false"}}
4 4  #macro (display4Cards $cards)
5 - <ul class="card-list">
5 + <div class="row">
6 6   #foreach ($card in $cards)
7 - <li class='card'>
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">
8 8   #helpExampleCard($card)
9 - </li>
19 + </div>
10 10   #end
11 - </ul>
21 + </div>
12 12  #end
13 13  
14 14  #set ($howToCards = [{
15 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)"
26 + 'title': 'Getting Started',
27 + 'description': 'Easy steps to get you started with XWiki.',
28 + 'documentation': "http://enterprise.xwiki.org/xwiki/bin/view/GettingStarted/WebHome?version=$escapetool.url($xwiki.version)"
19 19  }, {
20 20   'icon': 'fa fa-play-circle',
21 - 'title': $services.localization.render('help.videos.title'),
22 - 'description': $services.localization.render('help.videos.description'),
31 + 'title': 'Videos',
32 + 'description': 'View our collection of video tutorials.',
23 23   'documentation': 'Help.Videos.WebHome'
24 24  }])
25 25  
... ... @@ -28,21 +28,21 @@
28 28  #else
29 29   ## We need to generate the page history because the Extension Manager doesn't import it.
30 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'),
41 + 'content': 'Check',
42 + 'comment': 'Initial version',
33 33   'form_token': $services.csrf.token,
34 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'),
45 + 'title': 'Page History',
46 + 'content': 'Check mate',
37 37   'form_token': $services.csrf.token,
38 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'),
49 + 'title': 'History',
50 + 'content': 'Check the **history**.',
51 + 'comment': 'Minor change',
42 42   'minorEdit': 1,
43 43   'form_token': $services.csrf.token,
44 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')",
55 + 'content': "Check the **history** tab.$util.newline${util.newline}Compare the versions.",
46 46   'form_token': $services.csrf.token,
47 47   'xredirect': $xwiki.getURL('Help.History.WebHome', 'view', $NULL, 'History')
48 48   }))
... ... @@ -53,60 +53,60 @@
53 53  
54 54  #set ($featureCards = [{
55 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',
66 + 'title': 'Page Editing',
67 + 'description': "Use a powerful <a href=""http://platform.xwiki.org/xwiki/bin/view/Features/PageEditing"" class=""wikiexternallink"">WYSIWYG</a> content editor or <a href=""$xwiki.getURL('XWiki.XWikiSyntax')"">syntax</a> to create rich wiki pages.",
68 + 'documentation': 'http://platform.xwiki.org/xwiki/bin/view/Features/PageEditing',
59 59   'examples': $xwiki.getURL('Sandbox.WebHome', 'edit', 'editor=wysiwyg')
60 60  }, {
61 61   'icon': 'fa fa-file-text-o',
62 - 'title': $services.localization.render('help.templates.title'),
63 - 'description': $services.localization.render('help.templates.description'),
72 + 'title': 'Templates',
73 + 'description': 'Templates are predefined pages that are copied when creating a new page.',
64 64   'documentation': 'Help.Templates.WebHome',
65 65   'examples': $xwiki.getURL('Help.Templates.WebHome', 'view', $NULL, 'HExamples')
66 66  }, {
67 67   'icon': 'fa fa-file-excel-o',
68 - 'title': $services.localization.render('help.macros.title'),
69 - 'description': $services.localization.render('help.macros.description'),
78 + 'title': 'Macros',
79 + 'description': 'Macros are reusable functionality that can be integrated inside a page.',
70 70   'documentation': 'Help.Macros.WebHome',
71 71   'examples': $xwiki.getURL('Help.Macros.WebHome', 'view', $NULL, 'HExamples')
72 72  }, {
73 73   'icon': 'fa fa-files-o',
74 - 'title': $services.localization.render('help.applications.title'),
75 - 'description': $services.localization.render('help.applications.description'),
84 + 'title': 'Applications',
85 + 'description': 'Applications allow to group related structured pages together.',
76 76   'documentation': 'Help.Applications.WebHome',
77 77   'examples': $xwiki.getURL('Help.Applications.WebHome', 'view', $NULL, 'HExamples')
78 78  }, {
79 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/',
90 + 'title': 'Content Organization',
91 + 'description': 'Organize your content in hierarchical pages, grouped in several (sub)wikis.',
92 + 'documentation': 'http://platform.xwiki.org/xwiki/bin/view/Features/ContentOrganization/',
83 83   'examples': $xwiki.getURL('Main.AllDocs', 'view', 'view=tree')
84 84  }, {
85 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',
96 + 'title': 'Version Control',
97 + 'description': 'View previous versions of a page, compare different versions or rollback to any past version.',
98 + 'documentation': 'http://platform.xwiki.org/xwiki/bin/view/Features/VersionControl',
89 89   'examples': $historyURL
90 90  }, {
91 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'
102 + 'title': 'Import / Export',
103 + 'description': 'Import content from various sources and export it in an open format (XML, HTML, PDF, ODT).',
104 + 'documentation': 'http://platform.xwiki.org/xwiki/bin/view/Features/Imports'
95 95  }])
96 96  {{/velocity}}
97 97  
98 98  {{velocity}}
99 -= $services.localization.render('help.title1') =
109 += How to use XWiki? =
100 100  
101 -$services.localization.render('help.description1')
111 +XWiki offers a wide range of powerful features that will enable you to create, organize and find content. This section will show you how to use the basic features of XWiki.
102 102  
103 103  {{html clean="false"}}
104 104  #display4Cards($howToCards)
105 105  {{/html}}
106 106  
107 -= $services.localization.render('help.title2') =
117 += Main XWiki features =
108 108  
109 -$services.localization.render('help.description2')
119 +Congratulations for acquiring your XWiki instance. XWiki is very versatile and can be used to create knowledge bases, intranets or any type of business application you want. This is achievable because of XWiki's customization power, that starts at page level, from a simple to a more advanced usage.
110 110  
111 111  {{html clean="false"}}
112 112  #display4Cards($featureCards)
add_attachments.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.admin
Size
... ... @@ -1,0 +1,1 @@
1 +-1 bytes
Content
XWiki.UIExtensionClass[0]
Extension Parameters
... ... @@ -1,3 +1,3 @@
1 -label=$services.localization.render('help.title')
1 +label=Help
2 2  target=Help.WebHome
3 3  icon=icon:help