Changes for page Wiki Application

Summary

• Objects (1 modified, 0 added, 0 removed)
  • ExtensionCode.ExtensionClass[0]

Details

ExtensionCode.ExtensionClass[0]

Description

...	...	@@ -13,30 +13,37 @@
13	13	{{/box}}
14	14
15	15	A wizard helps you to create the wiki:
	16	+
16	16	(((
17		-{{image reference="wizard-wiki.png" /}}
	18	+{{image reference="wizard-wiki.png"/}}
18	18	)))
19	19
20	20	{{info}}
21	21	Since XWiki 7.1M2, if the [[Extension.Flavor Module]] is installed, you will get the following wizard:
	23	+
22	22	(((
23		-{{image reference="createwiki-flavors.png" /}}
	25	+{{image reference="createwiki-flavors.png"/}}
24	24	)))
	27	+
25	25	This wizard will allow you to select a flavor to install in the wiki, or to use a template as before. You can even create an empty wiki if you wish!
26	26	{{/info}}
27	27
28	28	In the second step, you will select how users can participate to the wiki. Is it open to everyone or does it an invitation? You will also select what kind of users are allowed (local users, specific to that wiki? Global users, that can go to other wikis of the system? Both?).
	32	+
29	29	(((
30		-{{image reference="wizard-user-scope.png" /}}
	34	+{{image reference="wizard-user-scope.png"/}}
31	31	)))
32	32
33	33	Then you will have a screen with a progress bar and a logging area that explains what is going on:
	38	+
34	34	(((
35		-{{image reference="WikiCreationStep.png" width="66%" /}}
	40	+{{image reference="WikiCreationStep.png" width="66%"/}}
36	36	)))
	42	+
37	37	You just have to wait for the end of the process, and you will see a success message and a button that invites you to go to the new created wiki.
	44	+
38	38	(((
39		-{{image reference="WikiCreationStepEnd.png" width="66%" /}}
	46	+{{image reference="WikiCreationStepEnd.png" width="66%"/}}
40	40	)))
41	41
42	42	{{info}}
...	...	@@ -43,13 +43,15 @@
43	43	=== For versions < 7.0M2: ===
44	44
45	45	After the second step, if you have not selected a template during the first step, you will see the [[Distribution Wizard>>platform:Features.DistributionWizard]], that will propose you to install the default application for wiki, called "XWiki Enterprise UI - Wiki". All you have to do is to click on "install" and to follow the instructions.
	53	+
46	46	(((
47		-{{image reference="dw.png" /}}
	55	+{{image reference="dw.png"/}}
48	48	)))
49	49
50	50	Otherwise, if you have selected a template, you will see a progress bar which indicates that the newly created wiki is provisionning by the system. You just have to wait until it completes, and then you can click on "finalize", to make the wiki perfectlly created.
	59	+
51	51	(((
52		-{{image reference="wizard-provisioning.png" /}}
	61	+{{image reference="wizard-provisioning.png"/}}
53	53	)))
54	54	{{/info}}
55	55
...	...	@@ -76,6 +76,7 @@
76	76	{{/box}}
77	77
78	78	On the "Drawer" menu, you can browse the wikis with the "Wiki Index":
	88	+
79	79	(((
80	80	{{image reference="wiki-index.png"/}}
81	81	)))
...	...	@@ -91,27 +91,36 @@
91	91	Note that currently the Home menu is not displayed on a subwiki where local users are enabled. The idea is to make this type of wikis "isolated" from the others. In the future, we plan to add an option to enable or disable the home menu display independently of whether there are local users or not.
92	92	{{/warning}}
93	93
	104	+{{image reference="descriptor.png"/}}
	105	+
94	94	== Templates ==
	107	+
95	95	A template is a wiki that will be considered as a model to create new wikis. When a user select a template to create a new wiki, all the content of the template is copied in the new wiki.
96	96
97	97	To create a new template, just click on "this wiki will be a template" in the wizard when you create a wiki.
	111	+
98	98	(((
99	99	{{image reference="wizard-new-template.png"/}}
100	100	)))
101	101
102	102	To see the list of existing templates, you can go to the "Wikis > Templates" section of the global administration (in the "Drawer" menu):
	117	+
103	103	(((
104	104	{{image reference="admin-wiki-template.png"/}}
105	105	)))
106	106
107	107	== Rights ==
	123	+
108	108	By default, only admins are able to create new wikis. You can decide to give this rights to other users in the "Wikis > Creation Rights" section of the global administration (in the "Drawer" menu):
	125	+
109	109	(((
110	110	{{image reference="wiki-creation-rights.png"/}}
111	111	)))
112	112
113	113	== How to join a wiki ==
	131	+
114	114	When a user wants to join a wiki, she just have to go on the "Wiki Index". Then, if the wiki is open to new users, there is link in the last column of the table to join the wiki. Depending of the configuration, she may have to perform a "join request", where she is invited to write a little text to explain why she wants to join the wiki.
	133	+
115	115	(((
116	116	{{image reference="join-request.png"/}}
117	117	{{image reference="join-request-2.png"/}}
...	...	@@ -118,12 +118,15 @@
118	118	)))
119	119
120	120	Then, her candidacy could be seen by the administrator of the wiki in the "users" section of the administration. The admin have the ability to accept or refuse the candidacy, and to write a message to the user to explain her decision. A private message is also proposed to store a comment about this candidacy, that the candidate will not see.
	140	+
121	121	(((
122	122	{{image reference="candidacies.png"/}}
123	123	)))
124	124
125	125	== Invite someone on a subwiki ==
	146	+
126	126	The administrator have the ability to add or simply to invite a user to join a wiki. It can be done in the "users" section of the administration of that wiki.
	148	+
127	127	(((
128	128	{{image reference="invite.png"/}}
129	129	)))
...	...	@@ -131,16 +131,17 @@
131	131	== Wiki Alias ==
132	132
133	133	Since XWiki 5.4.4, when you create the wiki without the "Path based" system to generate the URL of your wiki, the "Alias" of the wiki will be prompted in the creation wizard:
	156	+
134	134	(((
135	135	{{image reference="wikialias.png"/}}
136	136	)))
137	137
138		-You can choose the domain suffix to use (instead of letting XWiki compute a default alias) by setting the following property in your ##xwiki.properties##:(((
	161	+You can choose the domain suffix to use (instead of letting XWiki compute a default alias) by setting the following property in your ##xwiki.properties##:
139	139
	163	+(((
140	140	{{code}}
141	141	wiki.alias.suffix=mydomain.com
142	142	{{/code}}
143		-
144	144	)))
145	145
146	146	Then, if you create a wiki called "##test##", the suggested alias will be "##test.mydomain.com##".
...	...	@@ -152,6 +152,7 @@
152	152	{{info}}Since 6.4RC1{{/info}}, a new "Wikis > Descriptor" section is added in Administration where you can configure the current wiki, whether it is the main wiki or a subwiki.
153	153
154	154	The things you can change in this section are mostly the ones you`ve specified when you have created the wiki:
	178	+
155	155	* Pretty Name
156	156	* Description
157	157	* Owner (can be changed only by the current owner or user with edit rights on the wiki's descriptor, usually global admin)
...	...	@@ -164,24 +164,30 @@
164	164	{{image reference="wikiDescriptorEditingAdministration-cropped.png"/}}
165	165
166	166	== Delete a Wiki ==
	191	+
167	167	You can delete existing wikis by clicking on the corresponding "Delete" link in the Actions column of the wiki index.
168	168	Since 7.0 you will be asked on the confirmation screen to type in the wiki identifier for the wiki you want to delete:
	194	+
169	169	(((
170	170	{{image reference="delete-wiki-confirm-screen.png"/}}
171	171	)))
	198	+
172	172	This is to prevent wiki deletion by accident, as unlike most delete actions there is no undo for deleting wikis. (If this still happens you need to recover from a backup.)
173	173
	201	+
174	174	== "Wikis" Macro ==
175	175
176	176	This applications comes with a macro that lists available wikis:
177	177
178		-{{image reference="WikisMacro.png" /}}
	206	+{{image reference="WikisMacro.png"/}}
179	179
180		-{{info}}Since 6.4.1, it only lists the wikis that the user can access (ie having the "view" right on it).{{/info}}
	208	+{{info}}
	209	+Since 6.4.1, it only lists the wikis that the user can access (ie having the "view" right on it).
	210	+{{/info}}
181	181
182	182	To use it, edit a page, and with the WYSYWIG editor, go to "Macro > Insert Macro". In the modal window, select the "Navigation" category. There you will see the "Wikis" macro. Select it and click "Insert Macro". There is no parameter.
183	183
184		-{{image reference="WikisMacroInsert.png" /}}
	214	+{{image reference="WikisMacroInsert.png"/}}
185	185
186	186	Or to use this macro in the wiki editor, just write:
187	187
...	...	@@ -198,6 +198,7 @@
198	198	Then, the wizard will propose you to upgrade the subwikis also. You can upgrade all the wikis at once, or one by one, when you first go to them.
199	199
200	200	Here the screenshot of what you see if you select to upgrade all the wikis at once:
	231	+
201	201	(((
202	202	{{image reference="dw-wikisStep.png"/}}
203	203	)))
...	...	@@ -205,17 +205,20 @@
205	205	== For developers ==
206	206
207	207	=== Script Services ===
	239	+
208	208	If you want to make your own applications using the wiki management APIs, the following scripting services are available for handling wikis:
	241	+
209	209	* ##$services.wiki## or ##services.wiki## [[Javadoc for version 6.3>>http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-wiki-script/6.3/xwiki-platform-wiki-script-6.3-javadoc.jar/!/org/xwiki/wiki/script/WikiManagerScriptService.html]],
210	210	* ##$services.wiki.template## or ##services.wiki.template## [[Javadoc for version 6.3>>http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-wiki-template-script/6.3/xwiki-platform-wiki-template-script-6.3-javadoc.jar/!/org/xwiki/wiki/template/script/WikiTemplateManagerScript.html]],
211	211	* ##$services.wiki.user## or ##services.wiki.user## [[Javadoc for version 6.3>>http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-wiki-user-script/6.3/xwiki-platform-wiki-user-script-6.3-javadoc.jar/!/org/xwiki/wiki/user/script/WikiUserManagerScriptService.html]], **API marked as unstable, so subject to change**.
212	212	* ##$services.wiki.creationjob## or ##services.wiki.creationjob## {{info}}(since 7.0M2){{/info}} [[source code>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-creationjob/src/main/java/org/xwiki/platform/wiki/creationjob/script/WikiCreationJobScriptServices.java#L55-55]], **API marked as unstable, so subject to change**.
213	213
214		-=== Add an extra step during the wiki creation {{info}}(since 7.0M2){{/info}}===
	247	+=== Add an extra step during the wiki creation {{info}}(since 7.0M2){{/info}} ===
215	215
216	216	If you are a Java or a Groovy developer, you can easily add actions to perform during the creation of a new wiki.
217	217
218	218	Currently, the process is split in 4 different steps, that are executed successively:
	252	+
219	219	* [[Create Wiki>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-creationjob/src/main/java/org/xwiki/platform/wiki/creationjob/internal/steps/CreateWikiStep.java]] that only create a new empty wiki. //(Order: 1000)//
220	220	* [[Save Metadata>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-creationjob/src/main/java/org/xwiki/platform/wiki/creationjob/internal/steps/SaveWikiMetaDataStep.java]] that saves the information about the wiki owner, the user scope, the id of the flavor used, etc... //(Order: 2000)//
221	221	* [[Provision Wiki>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-creationjob/src/main/java/org/xwiki/platform/wiki/creationjob/internal/steps/ProvisionWikiStep.java]] that fills the wiki with a flavor or a template. //(Order: 3000)//
...	...	@@ -250,6 +250,7 @@
250	250	The ##execute()## method contains the code to execute when the step is processed. It takes a [[WikiCreationRequest>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-wiki/xwiki-platform-wiki-creationjob/src/main/java/org/xwiki/platform/wiki/creationjob/WikiCreationRequest.java#L37]] parameter that holds the information about the creation of the wiki (eg: the id of the wiki, the pretty name, etc...). It can actually hold all the information you want, since it has generic ##setProperty()## and ##getProperty()## methods.
251	251
252	252	=== Customize the Wiki Creation Wizard {{info}}(since 7.0M2){{/info}} ===
	287	+
253	253	Currently, there is no way to properly customize the wizard. The only thing you can do is editing it (it's only velocity code) to add your features. The page to edit is ##WikiManager.CreateWiki##.
254	254
255	255	The interesting thing is that you can store some settings in the WikiCreationRequest object that your step can re-use.
...	...	@@ -288,4 +288,3 @@
288	288	// etc, etc...
289	289	}
290	290	{{/code}}
291		-