Wiki source code of Documentation Flavor

Version 1.197 by Ecaterina Valica on 2013/03/15 13:52
Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("Improvements.WebHome")
3 $xwiki.ssx.use("Standards.WebHome")
4 {{/velocity}}
5
6 = Documentation Flavor =
7
8 {{toc depth="3"/}}
9
10 == Community Feedback ==
11
12 {{info}}
13 (7 Feb, 2013)
14 {{/info}}
15
16 (% class="left column40 dashboardleft" style="width: 27%" %)
17 (((
18 == Objective ==
19
20 A Documentation Wiki is an information repository about a certain topic (product, service, etc.)
21
22 It needs to provide means for information to be collected, organized, shared, searched and utilized.
23
24 == Use Cases ==
25
26 //**UC1**//: Public vs. Private Content: global or certain spaces
27 //**UC5**//: Related pages
28 //**UC6**//: Focus on page contributors
29 )))
30
31 (% class="dashboardright right column60 " style="width: 70%" %)
32 (((
33 {{comment}}
34 //**BUC1**//: Collect Information
35 Import (Office, CSV), Create, WYSIWYG, Workflow, Templates, Applications, Comments&Annotations
36 //**BUC2**//: Organize Information
37 Spaces, Tags, Metadata
38 //**BUC3**//: Share Information
39 Share by Email, Watchlist, RSS, PermaLinks, Mentions
40 //**BUC4**//: Search and Navigate Information
41 Search (also in the content of attachments), Livetable, Tag Clouds, Breadcrumbs, Tree
42 //**BUC5**//: Publish and Utilize Information
43 Read, Permissions, Comments, Export PDF, ODT, HTML; Internationalization, Backup
44 {{/comment}}
45
46 == Features ==
47
48 === Collect Information ===
49
50 {{container layoutStyle="columns"}}
51 (((
52 ==== Import ====
53 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.
54 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
55
56 ==== WYSIWYG ====
57 You can edit the wiki page in Syntax mode or WYSIWYG mode, which provides a way to create rich content with ease.
58 There will be a selection of [[macros>>||anchor='HMacros']] specialized for creating content, like adding layout, adding charts, images, table of content, footnotes, etc.
59 {{status group='M'/}} {{status group='D'/}}
60
61 ==== Comments & Annotations ====
62 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.
63 {{status group='O'/}} {{status group='D'/}}
64
65 )))
66 (((
67 ==== Workflow ====
68 Workflows are used to manage page stages, assign content contributors and publish only approved content.
69
70 Content will be first created, reviewed, approved and then published, following some predefined **stages** like: //'draft'//, //'in progress'//, //'approved'//, //'published'//, //'archived'//.
71
72 Users are separated in levels of **users** from: //'viewers'//, //'writers / contributors'//, //'editors / moderators'//, //'admins / webmasters'//, etc. each with their predefined [[rights>>||anchor="HRights"]].
73 {{status group='M'/}} {{status group='E'/}} {{status group='S'/}}
74
75 ==== Macros ====
76 {{status group='M'/}} {{status group='D'/}} {{status group='S'/}}
77 )))
78 (((
79 ==== Pages ====
80 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'//.
81 {{status group='M'/}} {{status group='D'/}}
82
83 ==== Templates ====
84 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]]
85 {{status group='M'/}} {{status group='D'/}} {{status group='S'/}}
86
87 ==== Applications ====
88 Alternative to [[Templates>>||anchor="HTemplates"]]. We could store the content in specialized Documentation Applications. They are using forms to add content input.
89 {{status group='O'/}} {{status group='D'/}} {{status group='S'/}}
90 )))
91 {{/container}}
92
93 === Organize Information ===
94
95 {{container layoutStyle="columns"}}
96 (((
97 ==== Spaces ====
98 Spaces are collections of wiki pages. They have separate administration, so they can have independent rights, presentation, backups, etc.
99 {{status group='M'/}} {{status group='D'/}}
100
101 ==== Metadata ====
102 {{status group='O'/}} {{status group='E'/}}
103 )))
104 (((
105 ==== Hierarchy ====
106 {{status group='M'/}} {{status group='E'/}}
107 )))
108 (((
109 ==== Tags ====
110 {{status group='M'/}} {{status group='D'/}}
111 )))
112 {{/container}}
113
114 === Share & Follow Information ===
115
116 {{container layoutStyle="columns"}}
117 (((
118 ==== Share by email ====
119 {{status group='O'/}} {{status group='D'/}}
120
121 ==== Watchlist ====
122 {{status group='O'/}} {{status group='D'/}}
123 )))
124 (((
125 ==== RSS ====
126 {{status group='O'/}} {{status group='D'/}}
127
128 ==== Permalink ====
129 {{status group='O'/}} {{status group='D'/}}
130 )))
131 (((
132 ==== Activity Stream ====
133 {{status group='O'/}} {{status group='D'/}}
134
135 ==== Mentions ====
136 {{status group='O'/}} {{status group='E'/}}
137 )))
138 {{/container}}
139
140 === Search and Navigate Information ===
141
142 {{container layoutStyle="columns"}}
143 (((
144 ==== Search ====
145 Also in the content of attachments
146 {{status group='M'/}} {{status group='D'/}}
147
148 ==== Tag Cloud ====
149 {{status group='M'/}} {{status group='D'/}}
150 )))
151 (((
152 ==== Livetable ====
153 {{status group='M'/}} {{status group='D'/}}
154
155 ==== Breadcrumb ====
156 {{status group='M'/}} {{status group='D'/}}
157 )))
158 (((
159 ==== Tree ====
160 {{status group='M'/}} {{status group='D'/}}
161 )))
162 {{/container}}
163
164 === Access and Utilize Information ===
165
166 {{container layoutStyle="columns"}}
167 (((
168 ==== Rights ====
169 The whole purpose of a documentation wiki is to make information accessible to the audience, while preserving the content [[workflow>>||anchor="HWorkflow"]].
170 There will be the following groups:
171
172 //'Viewers'//: can read articles and may leave comments;
173
174 //'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;
175
176 //'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;
177
178 //'Admin / Webmaster'//: have no restrictions. writer + editor rights + ability to create/manage users, manage global settings, view reports and statistics, take backup etc.
179 {{status group='M'/}} {{status group='D'/}}
180
181 )))
182 (((
183 ==== Export ====
184 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.
185 We need the ability to export a single page or [[multiple pages>>http://extensions.xwiki.org/xwiki/bin/view/Extension/MultipagePdfExport+Application+-+Space+Export]].
186 {{status group='M'/}} {{status group='D'/}} {{status group='E'/}}
187
188 ==== Backup & Archive ====
189 {{status group='M'/}} {{status group='D'/}}
190
191 )))
192 (((
193 ==== Internationalization ====
194 {{status group='O'/}} {{status group='D'/}}
195
196 ==== Comments & Ranking ====
197 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.
198 {{status group='O'/}} {{status group='D'/}}
199 )))
200 {{/container}}
201
202 === Instance Administration ===
203
204 {{container layoutStyle="columns"}}
205 (((
206 ==== LDAP ====
207 {{status group='M'/}} {{status group='D'/}}
208 )))
209 (((
210 ==== Skin & ColorTheme ====
211 {{status group='M'/}} {{status group='D'/}}
212 )))
213 (((
214 ==== Horizontal Menu ====
215 {{status group='O'/}} {{status group='E'/}}
216 )))
217 {{/container}}
218
219
220 (% class="clearfloats" %)
221 (((
222
223 )))
224 )))
225
226 (% class="clearfloats" %)
227
228 == Summary ==
229
230 (% class="statusTable" style="width:99%;"%)
231 |= Feature |=(%colspan='5' width='37%'%) Status
232 |[[Pages>>||anchor="HPages"]] (History, Attachments, Document Index) | {{status group='M'/}} | | {{status group='D'/}} | |
233 |[[Spaces>>||anchor="HSpaces"]]| {{status group='M'/}} | | {{status group='D'/}} | |
234 |[[Import>>||anchor="HImport"]]| {{status group='M'/}} | | {{status group='D'/}} | {{status group='E'/}} |
235 |[[Export>>||anchor="HExport"]]| {{status group='M'/}} | | {{status group='D'/}} | {{status group='E'/}} |
236 |[[Templates>>||anchor="HTemplates"]]| {{status group='M'/}} | | {{status group='D'/}} | | {{status group='S'/}}
237 |[[WYSIWYG>>||anchor="HWYSIWYG"]]| {{status group='M'/}} | | {{status group='D'/}} | |
238 |[[Macros>>||anchor="HMacros"]]| {{status group='M'/}} | | {{status group='D'/}} | | {{status group='S'/}}
239 |[[Workflow>>||anchor="HWorkflow"]]| {{status group='M'/}} | | | {{status group='E'/}} | {{status group='S'/}}
240 |[[Applications>>||anchor="HApplications"]]| | {{status group='O'/}} | {{status group='D'/}} | | {{status group='S'/}}
241 |[[Comments>>||anchor="HComments26Annotations"]]| | {{status group='O'/}} | {{status group='D'/}} | |
242 |[[Annotations>>||anchor="HComments26Annotations"]]| | {{status group='O'/}} | {{status group='D'/}} | |