Wiki source code of Public Website Flavor

Version 2.231 by Ecaterina Valica on 2013/03/18 16:53
Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("Improvements.WebHome")
3 $xwiki.ssx.use("Standards.WebHome")
4 $xwiki.ssx.use("Improvements.DocumentationFlavor")
5 {{/velocity}}
6
7 = Public Website Flavor =
8
9 {{toc depth="3"/}}
10
11 == Community Feedback ==
12
13 {{info}}
14 (7 Feb, 2013)
15 {{/info}}
16
17 (% class="left column40 dashboardleft" style="width: 27%" %)
18 (((
19 == Objectives ==
20
21 A Public Website is an
22
23 == Issues ==
24
25
26 )))
27
28 (% class="dashboardright right column60 " style="width: 70%" %)
29 (((
30 == Preview ==
31
32 {{gallery}}
33 image:LeiothrixHomeLanguages.png
34 {{/gallery}}
35
36 == Tasks & Features ==
37
38 === (% class="primaryTitle" %)Task:(%%) Collect Information ===
39
40 {{container layoutStyle="columns"}}
41 (((
42 ==== Import ====
43 Import [[Office>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Office+Importer+Application]] Documents (Word, [[Excel>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Batch+Import+Application]], Ppt) and other formats (CSV, DokuWiki, TWiki, MediaWiki, etc.) into wiki pages.
44 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
45
46 ==== WYSIWYG ====
47 You can edit the wiki page in Syntax mode or WYSIWYG mode, which provides a way to create rich content with ease.
48 There will be a selection of [[macros>>||anchor='HMacros']] specialized for creating content, like adding layout, adding charts, images, table of content, footnotes, etc.
49 {{status group='M'/}} {{status group='D'/}}
50
51 ==== Comments & Annotations ====
52 Collaboration and reviewing on wiki pages can be made through comments (global level) and annotations (contextual level) on unpublished content. The functionality could be disabled or [[enabled>>||anchor='HComments26Ranking']] on published content.
53 {{status group='O'/}} {{status group='D'/}}
54
55 )))
56 (((
57 ==== Workflow ====
58 [[Workflows>>https://github.com/xwiki-contrib/workflow-publication]] are used to manage page stages, assign content contributors and publish only approved content. This way we can control the access and make sure only high quality content is visible to end-users.
59
60 Content will be first created, reviewed, approved and then published, following some predefined **stages** like: //'draft'//, //'in progress'//, //'approved'//, //'published'//, //'archived'//.
61
62 Users are separated in levels of **users** from: //'viewers'//, //'writers / contributors'//, //'editors / moderators'//, //'admins / webmasters'//, etc. each with their predefined [[rights>>||anchor="HRights"]].
63 {{status group='M'/}} {{status group='E'/}} {{status group='S'/}}
64
65 ==== Macros ====
66 Macros add extra functionality inside wiki pages. There are certain macro categories, from [[content formatting>>||anchor='HWYSIWYG']] to application specific macros, that can be generally used or specific to documentation wikis (Workflow Status, Page Contributors, Related Pages, Rate content as useful etc.).
67 {{status group='M'/}} {{status group='D'/}} {{status group='S'/}}
68 )))
69 (((
70 ==== Pages ====
71 Pages are atomic entities of the wiki. They have //'Copy'//, //'Rename'//, //'Move'//, //'Delete'// functionality. Also you can manage the //'History'// (restore versions), add //Attachments// to them and manage them with //'Document Index'//.
72 {{status group='M'/}} {{status group='D'/}}
73
74 ==== Templates ====
75 We can create an empty page or use Page Templates, that contains predefined content and structure. Templates are integrated in the '//Create//' page action. See [[XE-897>>http://jira.xwiki.org/browse/XE-897]], [[XWIKI-6684>>http://jira.xwiki.org/browse/XWIKI-6684]]
76 {{status group='M'/}} {{status group='D'/}} {{status group='S'/}}
77
78 ==== Applications ====
79 Alternative to [[Templates>>||anchor="HTemplates"]]. We could store the content in specialized Documentation Applications. They are using forms to add content input.
80 {{status group='O'/}} {{status group='D'/}} {{status group='S'/}}
81 )))
82 {{/container}}
83
84
85
86 === (% class="primaryTitle" %)Task:(%%) Organize Information ===
87
88 {{container layoutStyle="columns"}}
89 (((
90 ==== Spaces ====
91 Spaces are collections of wiki pages. They have separate administration, so they can have independent rights, presentation, backups, etc.
92
93 Spaces organize pages in 'physical' locations, accessible through URLs.
94 {{status group='M'/}} {{status group='D'/}}
95
96 ==== Metadata ====
97 Add additional information on top of pages in order to provide additional layers of information and organization.
98 {{status group='O'/}} {{status group='S'/}}
99 )))
100 (((
101 ==== Hierarchy ====
102 Organize your content in hierarchical order by having parent-child relationships.
103
104 They organize the pages 'logically', across spaces.
105 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
106 )))
107 (((
108 ==== Tags ====
109 Tags can be added to pages to describe and categorize them. Can be visualized in [[Tag Clouds>>||anchor='HTagCloud']].
110
111 They organize the pages 'logically', across spaces.
112 {{status group='M'/}} {{status group='D'/}}
113 )))
114 {{/container}}
115
116
117
118 === (% class="primaryTitle" %)Task:(%%) Access and Utilize Information ===
119
120 {{container layoutStyle="columns"}}
121 (((
122 ==== Rights ====
123 The whole purpose of a documentation wiki is to make information accessible to the audience, while preserving the content [[workflow>>||anchor="HWorkflow"]].
124 There will be the following groups:
125
126 //'Viewers'//: can read articles and may leave comments;
127
128 //'Writer / Contributor'//: adds new articles, makes changes to his own articles, attach files to his own articles and all the new articles created by a writer are not published to the documentation unless they are moderated/approved by either an Editor or Admins;
129
130 //'Editor / Moderator'//: writer rights + create new articles, make changes to existing articles, create/manage categories, delete articles (but cannot access the ‘Trash’ for permanent deletion), create/manage tags;
131
132 //'Admin / Webmaster'//: have no restrictions. writer + editor rights + ability to create/manage users, manage global settings, view reports and statistics, take backup etc.
133 {{status group='M'/}} {{status group='D'/}} {{status group='S'/}}
134
135 )))
136 (((
137 ==== Export ====
138 The wiki displays the information as an online web page, but various output formats are needed for a wider audience. This should cover formats like XML, PDF, Word, ODT, Excel, CSV, HTML, DocBook XML, Dita XML, etc. but also the ability to print the content.
139 We need the ability to export a single page or [[multiple pages>>http://extensions.xwiki.org/xwiki/bin/view/Extension/MultipagePdfExport+Application+-+Space+Export]].
140 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
141
142 ==== Backup & Archive ====
143 Prevent information loss by having regular backups, useful also when doing upgrades or moving from one instance to another.
144
145 Archive functionality could be added to pages and spaces when they switch from 'Draft' to 'Publish' stage or when a new version for a documentation page replaces the older published version.
146 {{status group='M'/}} {{status group='D'/}}
147
148 )))
149 (((
150 ==== Comments & Ratings ====
151 Although [[comments>>||anchor='HComments26Annotations']] can be used in the content creation and validation process, they could also be enabled for the published content, in order to get feedback and rating from the viewers.
152 {{status group='O'/}} {{status group='D'/}}
153 )))
154 {{/container}}
155
156
157
158 === (% class="primaryTitle" %)Task:(%%) Search & Navigate Information ===
159
160 {{container layoutStyle="columns"}}
161 (((
162 ==== Search ====
163 Search for content inside pages, comments, objects and also in the content of attachments. You can restrict your search results by using filters based on location, content type, modification date, author, etc.
164
165 Also the Search Suggest feature rapidly displays the top matches for a certain query and highlights documents name, document content, attachment content and user names.
166 {{status group='M'/}} {{status group='D'/}}
167
168 )))
169 (((
170 ==== Livetable ====
171 Livetables allow filtering of pages that share structured data. You can view multiple details on a certain page, like name, location, author, modification date, images, etc. Pages selection can be done for an entire space, wiki, tag, author, etc.
172 {{status group='M'/}} {{status group='D'/}}
173
174 ==== Breadcrumbs ====
175 Breadcrumbs display for a certain page it's parent / child relation and position in the documents hierarchy.
176 {{status group='M'/}} {{status group='D'/}}
177 )))
178 (((
179 ==== Tag Cloud ====
180 The [[Tag>>||anchor='HTags']] Cloud display all the tags found for a certain use case (in a certain space, or by a certain author) and lets you browse pages that are labeled with the same tag.
181 {{status group='M'/}} {{status group='D'/}}
182
183 ==== Tree ====
184 You can visualize the hierarchy of pages starting from a specific parent or location. We need a tree integrated in the left panels, used for navigation.
185 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
186 )))
187 {{/container}}
188
189
190
191 === (% class="primaryTitle" %)Task:(%%) Share & Follow Information ===
192
193 {{container layoutStyle="columns"}}
194 (((
195 ==== Permalink ====
196 Have permanent links to point to your content. This mechanism is mandatory and built in for pages, but you can also link to comments, sections of content, attachments, users, certain version of the content, etc.
197 {{status group='M'/}} {{status group='D'/}}
198
199 ==== RSS ====
200 Changes and activity notifications are also available in RSS format in order to stay up to date. There are some pre-defined feeds that you can subscribe (activity stream, blog, etc.).
201 {{status group='O'/}} {{status group='D'/}}
202 )))
203 (((
204 ==== Activity Stream ====
205 Activity Stream lets you monitor the activity on pages, comments, attachments, by seing new, edited, deleted content. The Activity Stream is an useful tool in the creation process by highlighting additions and contributions.
206
207 Is less effective on published content, since that content doesn't suffer many changes.
208 {{status group='O'/}} {{status group='D'/}}
209
210 ==== Share by email ====
211 You can share pages through mail or with other users. The pages can be just linked or embedded inside the message, containing comments and attachments.
212 {{status group='O'/}} {{status group='D'/}}
213 )))
214 (((
215 ==== Watchlist ====
216 Get informed about wiki modifications with the watch feature. You will be notified by email of any changes to the pages: edit, delete content, comments, attachments, etc.
217
218 You can specify the frequency and delay of the e-mails. Also you are automatically subscribed to pages you contributed.
219
220 Is less effective on published content, since that content doesn't suffer many changes.
221 {{status group='O'/}} {{status group='D'/}}
222
223 ==== Send message ====
224 You can send message internally to wiki users, mentioning pages of interest, links or just content.
225 {{status group='O'/}} {{status group='D'/}}
226 )))
227 {{/container}}
228
229
230
231 === (% class="primaryTitle" %)Task:(%%) Instance Administration ===
232
233 {{container layoutStyle="columns"}}
234 (((
235 ==== Authentification ====
236 You can create your own user base and let them authenticate with XWiki credentials or you can delegate the authentification to [[LDAP>>http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP+Application]] and get their credentials from external servers.
237 {{status group='M'/}} {{status group='D'/}}
238 )))
239 (((
240 ==== Presentation ====
241 Public Websites usually have a custom skin in accordance with the company/product brand (logo, colors, etc.)
242
243 There is an [[extension skin>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Leiothrix+Skin]] designed especially for Public Websites.
244
245 The skin needs an [[Horizontal Menu>>http://extensions.xwiki.org/xwiki/bin/view/Extension/NavigationMenuConfig]] to contain links to important sections. Also a fat footer should be set in place.
246
247 The Homepage should host a Carousel with the top offers / products.
248 {{status group='M'/}} {{status group='E'/}} {{status group='S'/}}
249 )))
250 (((
251 ==== Internationalization ====
252 There are over 21 language available for your website, depending on the audience you need to handle. Also you can add your own translation or improve a current one.
253 {{status group='O'/}} {{status group='D'/}}
254 )))
255 {{/container}}
256
257
258
259 === (% class="primaryTitle" %)Task:(%%) Components ===
260
261 {{container layoutStyle="columns"}}
262 (((
263 ==== Blog ====
264 {{status group='M'/}} {{status group='D'/}}
265
266 )))
267 (((
268
269 )))
270 (((
271
272 )))
273 {{/container}}
274
275 (% class="clearfloats" %)
276 (((
277 )))
278
279 )))
280
281 (% class="clearfloats" %)
282 (((
283 )))
284
285 == Features Summary ==
286
287 (% class="statusTable" %)
288 |= Feature |=(% colspan="6" width="40%" %) Status
289 |[[Authentification>>||anchor="HAuthentification"]] |{{status group="M"/}} | |{{status group="D"/}} | | |
290 |[[Presentation>>||anchor="HPresentation"]]|{{status group="M"/}}| | |{{status group="E"/}}{{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/Leiothrix+Skin{{/footnote}} {{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/NavigationMenuConfig{{/footnote}}| {{status group="S"/}} |
291 |[[Internationalization>>||anchor="HInternationalization"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
292 |[[Blog>>||anchor="HBlog"]] |{{status group="M"/}} | |{{status group="D"/}} | | |
293
294 |[[Pages>>||anchor="HPages"]] (History, Attachments, Document Index) |{{status group="M"/}} | |{{status group="D"/}} | | |
295 |[[Spaces>>||anchor="HSpaces"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
296 |[[WYSIWYG>>||anchor="HWYSIWYG"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
297 |[[Backup>>||anchor="HBackup26Archive"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
298 |[[Permalink>>||anchor="HPermalink"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
299 |[[Search>>||anchor="HSearch"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
300 |[[Livetable>>||anchor="HLivetable"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
301 |[[Tags>>||anchor="HTags"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
302 |[[Breadcrumbs>>||anchor="HBreadcrumbs"]]|{{status group="M"/}} | |{{status group="D"/}} | | |
303 |[[Tree>>||anchor="HTree"]]|{{status group="M"/}} | |{{status group="D"/}} | {{status group="E"/}} | |
304 |[[Hierarchy>>||anchor="HHierarchy"]]|{{status group="M"/}} | |{{status group="D"/}} |{{status group="E"/}}{{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/HierarchyMacro{{/footnote}}| |
305 |[[Import>>||anchor="HImport"]]|{{status group="M"/}} | |{{status group="D"/}}{{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/Office+Importer+Application{{/footnote}} |{{status group="E"/}}{{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/Batch+Import+Application{{/footnote}} | |
306 |[[Export>>||anchor="HExport"]]|{{status group="M"/}} | |{{status group="D"/}} |{{status group="E"/}}{{footnote}}http://extensions.xwiki.org/xwiki/bin/view/Extension/MultipagePdfExport+Application+-+Space+Export{{/footnote}}| |
307 |[[Macros>>||anchor="HMacros"]]|{{status group="M"/}} | |{{status group="D"/}} | |{{status group="S"/}} |
308 |[[Templates>>||anchor="HTemplates"]]|{{status group="M"/}} | |{{status group="D"/}} | |{{status group="S"/}} |
309 |[[Rights>>||anchor="HRights"]]|{{status group="M"/}} | |{{status group="D"/}} | |{{status group="S"/}} |
310 |[[Workflow>>||anchor="HWorkflow"]]|{{status group="M"/}} | | |{{status group="E"/}}{{footnote}}https://github.com/xwiki-contrib/workflow-publication{{/footnote}}|{{status group="S"/}} |
311 |[[Comments>>||anchor="HComments26Annotations"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
312 |[[Annotations>>||anchor="HComments26Annotations"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
313 |[[Activity Stream>>||anchor="HActivityStream"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
314 |[[Send message>>||anchor="HSendmessage"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
315 |[[Share by email>>||anchor="HSharebyemail"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
316 |[[Watchlist>>||anchor="HWatchlist"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
317 |[[RSS>>||anchor="HRSS"]]| |{{status group="O"/}} |{{status group="D"/}} | | |
318 |[[Applications>>||anchor="HApplications"]]| |{{status group="O"/}} |{{status group="D"/}} | |{{status group="S"/}} |
319
320 {{putFootnotes/}}