Last modified by Ecaterina Moraru (Valica) on 2019/03/28 08:07

Show last authors
1 {{velocity}}
2 $xwiki.ssx.use('Proposal.Flavors.TechnicalDocumentationFlavor.WebHome')
3 {{/velocity}}
4
5 (% class="container-fluid" %)
6 (((
7 (% class="row" %)
8 (((
9 (% class="col-xs-12 col-md-4" %)
10 (((
11 {{box title="Content"}}
12 {{toc start="2" /}}
13 {{/box}}
14 )))
15
16 (% class="col-xs-12 col-md-8" %)
17 (((
18 {{gallery class="pull-right"}}
19 image:Propo[email protected]default_homepage.png
20 image:Pro[email protected]xwiki_doc_partial.png
21 image:Pro[email protected]maven_doc_partial.png
22 image:Pro[email protected]maven_homepage_partial.png
23 image:Pro[email protected]xwiki_homepage_partial.png
24 {{/gallery}}
25 )))
26 )))
27
28
29 (% class="row" %)
30 (((
31 (% class="col-xs-12 col-md-4" %)
32 (((
33 (% class="row" %)
34 (((
35 (% class="col-xs-12" %)
36 (((
37 == Purpose ==
38
39 Create a flavor that allows easy creation of XWiki instances suited for writing technical documentation.
40
41 The instance will contain documentation for a specific project, from user guides to API references and FAQs. Pages will contain from simple content like images and code samples, to macros and applications targeted towards software development.
42
43 Can be used by people wanting to provide support for a particular software or by developers that maintain and develop one.
44 )))
45
46 (% class="col-xs-12" %)
47 (((
48 Allows easy:
49 - customisation of the appearance (colors, logo, header);
50 - customisation of navigation links from menu and footer;
51 - and also allows creating a landing page with a specific layout in addition to the documentation layout.
52
53 Just like any XWiki instance, it is very extensible by supporting applications related to software development like Release Notes, IRC Archives, GitHub Stats, Dashboards, etc.
54 )))
55 )))
56 )))
57
58 (% class="col-xs-12 col-md-8" %)
59 (((
60 == Features ==
61
62 (% class="table-hover table" %)
63 (% class="active" %)|=(% colspan="100" %) Basic
64 |=(% rowspan="5" %)Features |(% colspan="4" %) Pages Basic: Create, Edit, etc.
65 |(% colspan="4" %) Versioning, History, Changes, Blame
66 |(% colspan="4" %) Export to PDF, XAR, Backup
67 |(% colspan="4" %) Administration, Rights (Open / Public Website) + Private / Internal Pages
68 |(% colspan="2" %) Search + Quick Search | Livetable | Profile
69 |= Macros |(% colspan="2" %) Box, Info, etc.|(% colspan="3" %) Code, Tree, Gallery, Toc, etc.
70 (% class="active" %)|=(% colspan="100" %) Advanced / Thematic / Optional
71 |= Configuration | Custom Domain | Subdomains | HTTPS support | Hosting
72 |= Templates | Roadmap | Download, Installation | Contribute | 404
73 |= Macros | Jira | Chart | Twitter | Google (YouTube, Maps, Calendar)
74 |=(% rowspan="2" %) Apps | FAQ, Forum | Blog | Dashboard | Stats
75 | Release Notes | GitHub Stats | Flash messages | Version archive
76 |= Extra | Workflow | Internationalization | Spam Protection | IRC Bot
77 |= Integrations| GitHub | Markdown | Google Analytics |\\
78 )))
79 )))
80
81 (% class="row" %)
82 (((
83 (% class="col-xs-12" %)
84 (((
85 ----
86
87 == Skin: Dove ==
88
89 {{display reference=".ExampleDefault.WebHome" section="HContent"/}}
90 )))
91 )))
92
93 ----
94
95 (% class="row" %)
96 (((
97 (% class="col-xs-12" %)
98 (((
99 == Examples ==
100 )))
101
102 (% class="col-xs-12 col-md-6" %)
103 (((
104 === Project: XWiki ===
105
106 {{display reference=".ExampleXWiki.WebHome" section="HContent"/}}
107 )))
108
109 (% class="col-xs-12 col-md-6" %)
110 (((
111 === Project: Apache Maven ===
112
113 {{display reference=".ExampleMaven.WebHome" section="HContent"/}}
114 )))
115 )))
116
117 ----
118
119 (% class="row" %)
120 (((
121 (% class="col-xs-12" %)
122 (((
123 == Implementation ==
124 )))
125
126 (% class="col-xs-12 col-md-6" %)
127 (((
128 === Differences ===
129
130 * Flavor
131 ** Removed Help, Sandbox application
132 ** Remove all macros or applications not needed by the use case
133 ** Marked as hidden some XWiki pages
134
135 * Skin
136 ** Different fonts for text and code
137 ** Hidden tags, last modified, created area
138 ** Removal of #docextra from WebPreferences
139 ** Display viewers in the "More actions" menu even if #docextra is hidden
140 ** New save buttons layout
141
142 * Menu
143 ** Fixed top menu
144 ** Menu integrated inside primary navbar (#menuview)
145 ** Removal of avatar and notification UIX
146 ** Style adjustments (text-transform, etc.)
147 ** Drawer should simply entries
148
149 * Panels
150 ** WebPreferences using a left only panels layout + large panels width
151 ** Navigation panel using document reference to display children
152 ** Panel header style adjustments
153 ** Edit mode using large panels width
154 ** Adjust width for large panels width on big resolutions
155
156 * Custom
157 ** Header is displayed only on Main.WebHome (custom velocity + ssx; careful on edit mode)
158 )))
159
160 (% class="col-xs-12 col-md-6" %)
161 (((
162 === Issues ===
163
164 * Needing UIX points or default pages that are included in the Header, Menu, Footer area
165 * Providing default templates for Header, Menu and Footer
166 * Provide Administration area to modify the Header, Menu and Footer
167 * Provide the font also locally or make a call to Google Fonts for online instances
168 * Menu: reordering pages (non alphabetical order)
169
170 === Additional ===
171
172 * Provide alternative templates for Header
173 * Provide 3 tested ColorThemes for the skin (see how to separate from the default ones - maybe not install them by default)
174 )))
175 )))
176
177 (% class="row" %)
178 (((
179 (% class="col-xs-12 col-md-6" %)
180 (((
181
182 )))
183
184 (% class="col-xs-12 col-md-6" %)
185 (((
186
187 )))
188 )))
189
190
191 )))

Get Connected