Standard URL Format (XWiki.org)

The general format of XWiki URLs is {{code language="none"}}<protocol>://<server>/<context path>/<type>/<path>{{/code}}, where:

6

7

* ##<protocol>##: by default it's ##http##. It's possible to use ##https##. It's generally deduced from the URL used by the client but it's possible to control it using [[the wiki descriptor>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Wiki+Application#HConfigureWiki]]

8

* ##<server>##: the XWiki instance address and port, e.g. ##localhost:8080##, ##xwiki.org##. In domain-mode the server also contains the subwiki name. See [[Accessing a wiki>>xwiki:Documentation.AdminGuide.AccessWiki]]. In path-based mode, the server is the address of the main wiki. Since 10.7 it's possible to customize the port to use in the [[the wiki descriptor>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Wiki+Application#HConfigureWiki]].

9

* ##<context path>##: the name under which the XWiki web application is deployed in your Servlet Container, e.g. ##xwiki##. See [[Short URLs>>xwiki:Documentation.AdminGuide.ShortURLs#HI.Applicationname]] if you wish to deploy XWiki as ROOT.

10

* ##<type>##: the type of URL depending on the XWiki subsystem accessed. The following types are supported:

11

** ##bin##: points to a dynamic resource. Examples: an Entity to display (wiki, page, space, attachment, object, property, etc), a dynamic skin resource (image, css, js), a dynamic template resource (image, js, css, icon, etc) and more. By dynamic we mean that some computation needs to happen to compute the resource (for example some Velocity needs to be evaluated).

12

** ##wiki##: this is similar to ##bin## but specifying the subwiki to access, in path-based mode (See [[Accessing a wiki>>xwiki:Documentation.AdminGuide.AccessWiki]]).

13

** ##rest##: points to a [[REST Resource>>xwiki:Documentation.UserGuide.Features.XWikiRESTfulAPI]]

14

** ##skins##: points to a static filesystem skin resource (image, js, css, etc), i.e. a resource located inside a skin directory on the filesystem.

15

** ##resources##: points to a static template resource (image, js, css, etc) on the filesystem.

16

** ##xmlrpc##: points to the now deprecated XMLRPC API (see [[extensions:Extension.XML-RPC Integration]] for more details).

17

** ##webdav##: points to a WebDAV resource (see [[Web DAV>>xwiki:Documentation.UserGuide.Features.WebDAV]] for more details).

18

* ##<path>##: the path completely depends on the ##<type>## used. See below for more details.

19

20

21

If you're interested in configuring the XWiki URLs, check the [[URL Architecture page>>Documentation.DevGuide.Architecture.URL Architecture.WebHome]].

= Type: ##bin## =

XWiki 7.2: Added support for Nested Spaces

28

29

30

There are various ##bin## URLs. The generic format of ##bin## URLs is ##bin/<action>/<path>##.

31

There is two ways to inject actions:

32

33

* by implementing an [[Entity Resource Reference Handler>>extensions:Extension.Resource API#HAddinganewEntityResourceTypeHandler]]

34

* {{warning}}deprecated{{/warning}} implementing a ##com.xpn.xwiki.internal.web.LegacyAction## since 13.0 or before 13.0 by listing a Struts action in the Strut Configuration file (located in ##WEB-INF/struts-config.xml##).

35

36

Here are some well-known actions:

37

38

* [[##skin##>>#HAction:skin]]: Dynamic Skin resource, e.g. ##http:~/~/<server>/xwiki/bin/skin/resources/uicomponents/search/searchSuggest.css##

39

* ##jsx##: [[Javascript Skin Extension>>xwiki:Documentation.DevGuide.Tutorials.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/jsx/AnnotationCode/Settings?language=en##

40

* ##ssx##: [[StyleSheet Skin Extension>>xwiki:Documentation.DevGuide.Tutorials.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/ssx/AnnotationCode/Style?language=en##

41

* [[##download##>>#HAction:download]]: URL to access an attachment from a wiki page, e.g. ##http:~/~/<server>/xwiki/bin/download/XWiki/JohnDoe/john.png?width=30&height=30&keepAspectRatio=true##

42

* [[##view##>>#HAction:view]]: Display Entity content (wiki, page, space, attachment, object, property, etc) with the skin applied, e.g. ##http:~/~/<server>/xwiki/bin/view/Sandbox/WebHome##

43

* [[##edit##>>#HAction:edit]]: Edits wiki content (page, object, property, etc), e.g. ##http:~/~/<server>/xwiki/bin/edit/Sandbox/WebHome##

44

* [[##get##>>#HAction:get]]: Accessing Entity content (wiki, page, space, attachment, object, property, etc) without any skin applied, e.g. ##http:~/~/<server>/xwiki/bin/get/Main/WebHome?xpage=xpart&vm=commentsinline.vm##. The ##get## action should be used to render the content of the page and nothing else (mainly used for code pages). This action is similar to the ##view## action, but without the UI and with "text/plain" mime type set by default for the response.

45

* ##export##: Exports wiki pages to various formats (PDF, HTML, etc). See [[xwiki:Documentation.UserGuide.Features.Exports]].

46

* [[##create##>>#HAction:create]]: Provides the UI for creating new documents, e.g. ##http:~/~/<server>/xwiki/bin/create/Space/NewDocument##

47

* [[##objectadd##>>#HAction:objectadd]]: Adds an XObject, e.g. ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=Some.XClass##

48

49

== Action: ##view## ==

50

51

The additional URL paths for the ##view## action is ##<space1>/.../<spaceN>/<page>?<query string>## or ##<space1>/.../<spaceN>?<query string>##

Examples:

* ##http:~/~/<server>/xwiki/bin/view/Sandbox/WebHome##: Views the ##Sandbox.WebHome## page.

56

* ##http:~/~/<server>/xwiki/bin/view/Sandbox##: Views the ##Sandbox.WebHome## page.

57

* ##http:~/~/<server>/xwiki/bin/view/Space1/Space2##: Views the ##Space1.Space2.WebHome## page (if the ##Space2## page doesn't exist. If it exists then it views the ##Space1.Space2## page).

58

* ##http:~/~/<server>/xwiki/bin/view/Space1/Space2/##: Force to always views the ##Space1.Space2.WebHome## page (even if the ##Space2## page exists in the ##Space1## space. Note the ##/## at the end).

59

* ##http:~/~/<server>/xwiki/bin/view/Space1/Space2?spaceRedirect=false##: Force to always view the ##Space1.Space2## terminal page (even if the ##Space1.Space2.WebHome## page exists and even if the ##Space1.Space2## page may not exist).

60

61

Here are some of the supported query string parameters.

62

63

=== Parameter: ##xpage## ===

64

65

* ##plain##: this value indicates that only the content of the page is printed (no UI). With a document that's not using the XWiki Syntax 1.0 you can control the output syntax using ##outputSyntax## and ##outputSyntaxVersion##. You can also pass other parameters to allow fine-grained control:

66

** ##raw=1##: Returns the page source as is without any formatting but XML-escaped

67

** ##raw=2##: Returns the page source as is without any formatting (without any escaping)

68

** ##htmlHeaderAndFooter=true##: {{info}}Since 6.3RC1{{/info}} Display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).

69

** ##outputTitle##: {{info}}Since 7.3M2{{/info}} If ##true## then also display the title in addition to the content. Defaults to ##false## if not specified.

70

* ##xml##: print the exported form of a document. This is what you can find in the xar for each document.

71

* ##rev##: when specified, redirects to the ##viewrev## action (see below)

72

* ##children##: {{info}}Since 7.2M3{{/info}} display a page that lists all the children of the document. You can also add the following parameters:

73

** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism

74

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

75

* ##backlinks##: {{info}}Since 7.2M3{{/info}} display a page that lists all the documents having a link to the current document. You can also add the following parameters:

76

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

77

* ##siblings##: {{info}}Since 7.2RC1{{/info}} display a page that lists all the children of the parent of the document. You can also add the following parameter:

78

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

79

* ##hierarchy_reference##: {{info}}Since 7.3M2{{/info}} display the hierarchy of the page, as raw HTML, without any style. You can also add the following parameters:

80

** ##id=someId##: add an HTML id to the hierarchy breadcrumb.

81

** ##displayTitle=true|false##: display the title of the elements in the breadcrumb (default: true)

82

** ##excludeSelf=true|false##: display the hierarchy without the page itself (default: false)

83

** ##limit=##: maximum number of hierarchy elements displayed (default: none)

84

** ##local=true|false##: do not display the main wiki reference for documents located in sub-wikis. (default: false)

85

86

=== Parameter: ##outputSyntax## and ##outputSyntaxVersion## ===

87

88

With a document that's not using the XWiki 1.0 syntax it's possible to explicitly indicate the renderer to use for the page content. For example with ##outputSyntax=plain## you will get the result in plain text. ##outputSyntaxVersion## is an optional parameter, if it's not provided XWiki will search for the last version of the renderer for the given ##outputSyntax## syntax name. Note that ##outputSyntax## controls only the document content output syntax. If you only want the document content you can use ##xpage=plain##.

89

90

See [[extensions:Extension.Rendering Module]] for more details on renderers.

91

92

=== Parameter: ##viewer## ===

93

94

Note: if the document does not exist, you will have a 404 error page, and the following parameters will not be taken into account. Use ##xpage## if you need to have the desired behavior even if the document does not exist.

95

96

* ##attachments##: Display the attachment list (e.g. ##http:~/~/playground.xwiki.org/xwiki/bin/view/Sandbox/?viewer=attachments##)

97

* ##history##: Display the version history (e.g. ##http:~/~/playground.xwiki.org/xwiki/bin/view/Sandbox/?viewer=history##)

98

* ##comments##: Display the comments (e.g. ##http:~/~/playground.xwiki.org/xwiki/bin/view/Sandbox/?viewer=comments##)

99

* ##information##: Display the page information (e.g. ##http:~/~/playground.xwiki.org/xwiki/bin/view/Sandbox/?viewer=information##)

100

* ##children##: {{info}}Since 7.2RC1{{/info}} display a page that lists all the children of the document. You can also add the following parameters:

101

** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism

102

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

103

* ##backlinks##: {{info}}Since 7.2RC1{{/info}} display a page that lists all the documents having a link to the current document. You can also add the following parameter:

104

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

105

* ##siblings##: {{info}}Since 7.2RC1{{/info}} display a page that lists all the children of the parent of the document. You can also add the following parameter:

106

** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)

107

108

=== Parameter: ##spaceRedirect## ===

Accepted values:

* ##true## (default): By default, an URL not ending in ##/## resolves to a non-terminal page, unless the equivalent terminal page already exists.

113

* ##false##: An URL not ending in ##/## will always resolve to a terminal page.

114

115

Not applicable (i.e. no effect) for top-level pages and URLs ending in ##/##.

Examples:

* ##http:~/~/<server>/xwiki/bin/view/Space1/Space2[?spaceRedirect=true]##: Views the ##Space1.Space2.WebHome## page (if the ##Space2## page doesn't exist. If it exists then it views the ##Space1.Space2## page).

120

* ##http:~/~/<server>/xwiki/bin/view/Space1/Space2?spaceRedirect=false##: Force to always view the ##Space1.Space2## terminal page (even if the ##Space1.Space2.WebHome## page exists and even if the ##Space1.Space2## page may not exist).

121

* ##http:~/~/<server>/xwiki/bin/view/Space1[?spaceRedirect=false|?spaceRedirect=true|/]##: Will always view the ##Space1.WebHome## non-terminal page because it is a top level page and we can never have a top-level terminal page.

122

123

=== Parameter: ##restricted## ===

Since 11.5RC1

Accepted values:

* ##false## (default): the macro transformations are normally executed

132

* ##true##: macro transformations are executed in degraded mode or not executed at all, depending on the macro implementation.

133

134

In particular, various scripting macro such as [[Velocity Macro>>extensions:Extension.Velocity Macro]] or [[Groovy Macro>>extensions:Extension.Groovy Macro]] are not executed in restricted mode.

135

This parameter might be then use to check if a page is well displayed for user who cannot execute those scripts for example.

136

137

=== Parameter: ##rev## ===

Since 13.0.

The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##

144

145

=== Parameter: ##transformations## ===

146

147

148

Allows controlling precisely which Rendering Transformations to execute.

149

150

For example to only execute the Macro transformation: ##http:~/~/localhost:8080/xwiki/bin/view/Sandbox/WebHome?transformations=macro##

151

152

153

=== Special Anchors ===

154

155

When viewing a wiki page you can also specify an anchor ([[fragment identifier>>https://en.wikipedia.org/wiki/URI_fragment]]) in the URL to trigger some browser or JavaScript behavior. Here's a list of known anchors for view action:

156

157

* ##Hxxx##: anchors that start with ##H## are normally used to scroll the page to the specified heading (section of the page content)

158

* ##edit##: triggers the [[in-place editor>>Documentation.UserGuide.Features.PageEditing#HIn-placeeditingmode]] on page load, if in-place editing is enabled

159

* ##translate##: triggers the in-place editor for a missing page translation; the wiki needs to be multilingual and in-place editing enabled

160

161

== Action: ##viewrev## ==

162

163

=== Parameter: ##rev## ===

164

165

166

Deprecated since 13.0. Use ##view## action instead.

167

168

169

The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##

170

171

== Action: ##save## ==

172

173

The additional URL paths for the ##save## action is ##<space>/<page>?<query string>##.

Examples:

* ##http:~/~/<server>/xwiki/bin/save/Sandbox/WebHome##: Save the ##Sandbox.WebHome## page.

178

179

Here are some of the supported query string parameters.

180

181

=== Parameter: ##creator## ===

182

183

Change the creator of the current page. Should be a string as a Document Reference like ##JohnDoe##, ##XWiki.JohnDoe## or ##xwiki:XWiki.JohnDoe## which is a page containing an ##XWiki.Users## object.

184

185

=== Parameter: ##language## ===

186

187

Will target a specific language. You must use a specific 2-letters code (see [[I18N>>xwiki:Documentation.UserGuide.Features.I18N]]).

188

189

=== Parameter: ##objectPolicy## ===

190

191

{{info}}Since 7.1M1{{/info}} The ##objectPolicy## parameter is a request configuration parameter that will decide how to handle custom query string parameters (see [[Custom Parameters>>#HCustomParameters]]):

192

193

* ##update##

194

** Each custom parameter will update a property in an existing object of the current page.

195

** If the custom parameter refers to a property or an object that don't exist, it will simply ignore it.

196

* ##updateOrCreate##

197

** Each custom parameter will update a property in an existing object of the current page.

198

** If the custom parameter refers to a property that doesn't exist, it will ignore it.

199

** If the custom parameter refers to an object that doesn't exist, it will create it (and pad will ##null## objects if needed).(((

200

//Example//: If there is already 2 objects ##XWiki.XWikiRights## in the page, ##XWiki.XWikiRights_0_levels## and ##XWiki.XWikiRights_1_levels## will update these existing objects. ##XWiki.XWikiRights_2_levels## and ##XWiki.XWikiRights_3_levels## will create 2 new objects. ##XWiki.XWikiRights_42_levels## will be created and 37 empty objects too (42 minus the 4 already existing and minus the 42th which will be created).

201

//Note//: All this information about empty/null objects is currently an implementation detail of how we currently handle object numbers and it may be subject to future change so, as much as possible, do not rely on it and, instead, use the public available APIs to handle these things.

202

)))

203

204

=== Parameter: ##addedObjects## ===

205

206

{{info}}Since XWiki 12.4RC1{{/info}} The ##addedObjects## parameter allows to create new xobjects in a document without having to specify the value of its properties contrary to ##updateOrCreate## ##objectPolicy##. It can be useful in particular to create xobjects that don't have any property values (special xclass AppWithinMinutes.Content for example). The value of this parameter is an array of xobjects name on the form ##xclass_xobjectNumber##: for example, ##XWiki.XWikiRights_2##.

207

208

=== Parameter: ##deletedObjects## ===

209

210

{{info}}Since XWiki 12.4RC1{{/info}} The ##deletedObjects## parameter allows to delete xobjects in a document while saving. The value of this parameter is an array of xobjects name on the form ##xclass_xobjectNumber##: for example, ##XWiki.XWikiRights_2##.

211

212

=== Parameter: ##parent## ===

213

214

Allows you to set the parent of the page. Should be a string as a Document Reference like ##WebHome##, ##Main.WebHome## or ##xwiki:Main.WebHome##.

215

216

=== Parameter: ##syntaxId## ===

217

218

Specify which syntax is used for the content of the current page (see [[Supported syntaxes>>http://rendering.xwiki.org/xwiki/bin/view/Main/#HSupportedSyntaxes]]).

219

220

=== Parameter: ##template## ===

221

222

Allows you to have a specific template to apply for the current page. Should be a string as a Document Reference like ##MyTemplate##, ##Main.MyTemplate## or ##xwiki:Main.MyTemplate##.

223

224

=== Parameter: ##title## ===

225

226

Allows you to modify the title of the page.

227

228

=== Parameter: ##form_token## ===

229

230

A mandatory anti-CSRF token string which can be provided by the [[CSRF API>>extensions:Extension.XWiki Platform - CSRF.WebHome]].

231

232

=== Custom Parameters ===

233

234

Custom parameters have the format ##<Space>.<ClassPage>_<number>_<propertyname>## (e.g. ##XWiki.XWikiUsers_0_password## or ##XWiki.WatchListClass_3_interval##):

235

236

* ##<Space>## must refer to an existing space of the wiki

237

* ##<ClassPage>## must refer to a class

238

* ##<number>## is a positive number

239

* ##<propertyname>## is a name of a property of the class ##<Space>.<ClassPage>##

240

241

== Action: ##edit## ==

242

243

=== Parameter: ##editor## ===

244

245

The type of editor to be used on the page:

246

247

* ##inline##: to edit as an inline form

248

* ##class##: to open the class editor

249

* ##object:## to open the object editor

250

* ##wiki##: to open the wiki editor

251

* ##wysiwyg##: to open the WYSIWYG editor

252

253

When the editor parameter is not set, the default editor is automatically computed based on the type of page that is being edited.

254

255

=== Parameter: ##template## ===

256

257

Only applies if the page does not already exist: Allows you to have a specific template to apply for the current page, before it's loaded in edit mode. Should be a string as a Document Reference like ##MyTemplate##, ##Main.MyTemplate## or ##xwiki:Main.MyTemplate##.

258

259

=== Parameter: ##title## ===

260

261

Allows to have the passed title loaded in the title field of the edit form, if present.

262

263

=== Parameter: (% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)content(%%) ===

264

265

Allows to have the passed title loaded in the title field of the edit form, if present.

266

267

=== Parameter: ##section## ===

268

269

A number to [[edit a specific section>>Documentation.UserGuide.Features.PageEditing#HSectionEditing]] of the document. Applies to edit modes wiki and wysiwyg.

270

271

=== Parameter: ##form_token## ===

272

273

The anti-CSRF token string which can be provided by the [[CSRF API>>extensions:Extension.XWiki Platform - CSRF.WebHome]]. The token needs to be sent when template, title or content are parameters are used, in order to enable full display of the template, title or content used.

274

275

== Action: ##inline## ==

276

277

278

Deprecated since 3.2.

279

280

281

The additional URL paths for the ##inline## action is ##<space>/<page>?<query string>##.

Examples:

* ##http:~/~/<server>/xwiki/bin/inline/Sandbox/WebHome##: Edit in inline mode the ##Sandbox.WebHome## page.

286

287

For the supported query string parameters, you can refer to the [[##save## action>>#HAction:save]].

288

289

== Action: ##get## ==

290

291

=== Parameter: ##htmlHeaderAndFooter## ===

292

293

{{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).

294

295

== Action: ##download## ==

296

297

The additional URL paths for the ##download## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.

Example:

* ##http:~/~/<server>/xwiki/bin/download/Space1/Space2/WebHome/image.png##: Views the ##image.png## attachment located in the ##Space1.Space2.WebHome## page.

302

303

=== Parameter: ##force-download## ===

304

305

If set, force the attachment to be downloaded instead of being opened in the browser (it sets the ##Content-Disposition## header to ##attachment## instead of ##inline##).

306

307

== Action: ##downloadrev## ==

308

309

The additional URL paths for the ##downloadrev## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.

Example:

* ##http:~/~/<server>/xwiki/bin/downloadrev/Space1/Space2/WebHome/image.png?rev=1.2##: Views the revision ##1.2## of ##image.png## attachment located in the ##Space1.Space2.WebHome## page.

314

315

=== Parameter: ##rev## ===

316

317

The version to get, e.g. ##1.2## in ##http:~/~/<server>/xwiki/bin/downloadrev/Space1/Space2/WebHome/image.png?rev=1.2##

318

319

=== Parameter: ##force-download## ===

320

321

If set, force the attachment to be downloaded instead of being opened in the browser (it sets the ##Content-Disposition## header to ##attachment## instead of ##inline##).

322

323

== Action: ##create## ==

324

325

The additional URL paths for the create action is ##<space1>/.../<spaceN>/<page>?<query string>##.

Examples:

http:~/~/<server>/xwiki/bin/create/Space1/Space2/NewPage: UI for creating the Space1.Space2.NewPage document (also known as a terminal document).

330

http:~/~/<server>/xwiki/bin/create/Space1/Space2/WebHome: UI for creating the Space1.Space2.WebHome document (which is also known as a space homepage or a non-terminal document).

331

http:~/~/<server>/xwiki/bin/create/Main/WebHome: Generic UI for creating a new document (asking for location and document name since Main.WebHome already exists)

332

333

Here are some of the supported query string parameters.

334

335

=== Parameter: ##spaceReference## ===

336

337

{{info}}Since 7.2M1{{/info}} A local reference string serialization of the space in which to create the new document, e.g. "Space1.Space2"

338

339

//Note//: Since it's a serialized string reference, entity names need to be already escaped. For a space name "A.B", the equivalent local space reference would be "A\.B". Another example of serialized local space reference would be "A\.B.C\.D", meaning space "C.D" inside space "A.B". See the [[extensions:Extension.Model Module]]'s documentation for more information on EntityReferences.

340

341

=== Parameter: ##name## ===

342

343

{{info}}Since 7.2M1{{/info}} A string representing the name of the new entity, e.g. "NewDocument".

344

345

Depending on the type of document to create, this will be used as:

346

347

* a space name, when creating non-terminal documents, e.g. spaceReference=Space&name=Page results in creating "Space.Page.WebHome"

348

* a document name, when creating terminal documents, e.g. spaceReference=Space&name=Page&tocreate=terminal results in creating "Space.Page"

349

350

=== Parameter: ##tocreate## ===

Accepted values:

* empty or not specified:

355

** if the current document does not exist, a terminal document will be created having the current document's reference, e.g. ##/create/Space/NewPage## creates "Space.NewPage"

356

** if the current document exists, the new document (specified using the ##spaceReference## + ##name## parameters pair) is created as a non-terminal document, e.g. ##/create/Main/WebHome?spaceReference=Space&name=NewPage## creates "Space.NewPage.WebHome".

357

** {{warning}}Deprecated since 7.2M1{{/warning}} if the current document exists, the new document (specified using the deprecated ##space## + ##pageName## parameters pair) is created as a terminal document, e.g. ##/create/Main/WebHome?space=Space&page=NewPage## creates "Space.NewPage".

358

* "terminal" - forces the new document to be a terminal document.

359

** Example: If "Space1.Space2.Page" is to be created, then it is already a terminal document and is not affected in any way by this setting, but if "Space1.Space2.WebHome" is to be created then it would be a non-terminal document by default. In this later case, specifying the tocreate=terminal parameter would force the creation of a terminal document instead, result in the creation of ##Space1.Space2## (i.e. the page named "Space2" in the space "Space1"), effectively going up one level in the Nested Spaces hierarchy.

360

** In the case of a top level space's WebHome document (e.g. "Space.WebHome"), this setting is ignored, since the top limit of the hierarchy is reached and there is nowhere else to go up. The resulting document to be created is thus "Space.WebHome".

361

* "space" - {{warning}}Deprecated since 7.2M1{{/warning}} The document to be created will always be a space WebHome (a.k.a a non-terminal document). This value is considered only when used in conjunction with the deprecated ##space## parameter. In this case, the deprecated ##page## parameter is completely ignored. For example: ##tocreate=space&space=MySpace## will result in "MySpace.WebHome".

362

363

=== Parameter: ##template## ===

364

365

A string serialized document reference of the document to use as template when creating the new document.

366

367

If empty, the new document will be a blank page.

368

369

If not specified, and existing template providers are available to choose from in the current space and the ##templateprovider## parameter is also not specified, no document will be created yet and the create UI will show up asking the user to choose a template provider from a list.

370

371

This parameter has precedence over the ##templateprovider## parameter, meaning that if both are specified, the ##templateprovider## will be ignored.

372

373

=== Parameter: ##templateprovider## ===

374

375

A string serialized document reference of the template provider document to use when creating the new document. The actual template document to use will be extracted from the specified template provider.

376

377

If the specified template provider is not allowed to be used in the space where the new document is created, then the create UI will be displayed with an error.

378

//Note//: This check is done for the ##spaceReference## of the new document to be created. Example: If we are creating the terminal document "Space.NewPage", the check is done for the space "Space". However, if we are creating the non-terminal document "Space.NewPage.WebHome", the check is done for the non-terminal document's space "Space" and not for actual document's reference space "NewPage".

379

380

If empty, the new document will be a blank page.

381

382

If not specified, and existing template providers are available to choose from in the current space and the ##template parameter is also not specified, no document will be created yet and the create UI will show up asking the user to choose a template provider from a list.##

383

384

If both this parameter and the ##template## parameter are specified, the ##template## parameter will be used instead of and this parameter will be ignored.

385

386

=== Parameter: ##title## ===

387

388

A string to use as the title of the new document.

389

390

=== Parameter: ##form_token## ===

391

392

A mandatory anti-CSRF token string which can be provided by the [[CSRF API>>extensions:Extension.XWiki Platform - CSRF.WebHome]].

393

394

=== Parameter: ##parent## ===

395

396

{{warning}}Deprecated since 7.2M1{{/warning}} A string serialized document reference of the document to use as parent for the new document.

397

398

=== Parameter: ##space## ===

399

400

{{warning}}Deprecated since 7.2M1{{/warning}} A string representing an unescaped space name where the new document will be created, Example: "MySpace", "SpaceNameWith.Dots", etc.

401

402

//Note//: Because this is just a space name and not a space local reference, only top level space documents can be created, i.e. "TopLevelSpace.Document" is possible but not "TopLevelSpace.SecondLevelSpace.Document".

403

404

=== Parameter: ##pageName## ===

405

406

{{warning}}Deprecated since 7.2M1{{/warning}} A string representing the name of the new document. Example: "NewDocument"

407

408

//Note//: When using ##tocreate=space## in conjunction with the ##space## parameter, this parameter will be ignored and the document "<space>.WebHome" will be created.

409

410

== Action: ##skin## ==

411

412

Right now dynamic Skin Resources are handled as Entity Resources ([[which is not correct>>https://jira.xwiki.org/browse/XWIKI-12449]]).

413

414

The additional URL paths for the ##skin## action is

415

416

* ##<filesystem path to resource>?<optional query string>## for Filesystem-based Skins

417

* ##<space1>/.../<spaceN>/<page>/<attachment name>## for a resource attached to a wiki page. Note that Velocity is executed only if the attachment has a CSS or Javascript extension name.

418

* ##<space1>/.../<spaceN>/<page>/<xobject property name>## for Skins defined in wiki pages and having an ##XWiki.XWikiSkins## xobject with a property named ##<xobject property name>##. Note that Velocity is executed only if the ##<xobject property name>## name has a CSS or Javascript extension name.

Examples:

* ##http:~/~/<server>/xwiki/bin/skin/skins/flamingo/style.css?skin=XWiki.DefaultSkin&colorTheme=playground%3AFlamingoThemes.Charcoal##: Points to the ##style.css## resource located in the ##[xwiki webapp location]/skins/flamingo## directory on the filesystem (and if not found look for the resource in the base skin and default base skin).

423

* ##http:~/~/<server>/xwiki/bin/skin/resources/uicomponents/search/searchSuggest.css##: Points to the ##searchSuggest.css## resource located in the ##[xwiki webapp location]/resources/uicomponents/search## directory on the filesystem.

424

* ##http:~/~/<server>/xwiki/bin/skin/uicomponents/search/searchSuggest.css##: Similar as just above except that the ##resources## part has been omitted and if the resource doesn't exist in ##[xwiki webapp location]/uicomponents/search## then it's also searched for in ##[xwiki webapp location]/resources/uicomponents/search##

425

* ##http:~/~/<server>/xwiki/bin/skin/XWiki/DefaultSkin/somefile.css##: Points to the ##somefile.css## attachment in the ##XWiki.DefaultSkin## wiki page (and if not found look for the resource in the base skin and default base skin).

426

* ##http:~/~/<server>/xwiki/bin/skin/XWiki/DefaultSkin/edit.vm##: Points to the content of the ##edit.vm## property in the ##XWiki.XWikiSkins## xobject in the ##XWiki.DefaultSkin## wiki page (and if not found look for the resource in the base skin and default base skin).

427

428

== Action: ##objectadd## ==

429

430

Adds an XObject to the referenced page.

Examples:

* ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=Some.XClass##

435

* ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=XWiki.XWikiGroups&XWiki.XWikiGroups_member=XWiki.JohnDoe##

436

437

=== Parameter: ##classname## ===

438

439

The full name of the document that holds the class which the object to be added should be instance of. Example: ##XWiki.XWikiGroups##.

440

441

=== Parameter: ##<classname>_<fieldname>## ===

442

443

This is an optional parameter. You can initialize the XObject properties by passing parameter names of the form ##<classname>_<fieldname>##, where ##classname## is the value given in the ##classname## parameter above and ##fieldname## is the name of the xproperty field to initialize. For example: ##XWiki.XWikiGroups_member## (provided that ##XWiki.XWikiGroups## has been given for the mandatory ##classname## parameter).

444

445

=== Parameter: ##xredirect## ===

446

447

Optional parameter indicating the URL to redirect to once the object has been added.

448

449

For example: ##xredirect=/xwiki/bin/view/SomeSpace/SomePage##.

450

451

When not specified, you're redirected to the current page (the page specified in the URL) and using the object editor (##edit## action and ##editor=object## parameter).

452

453

=== Parameter: ##form_token## ===

454

455

A mandatory anti-CSRF token string which can be provided by the [[CSRF API>>extensions:Extension.XWiki Platform - CSRF.WebHome]].

456

457

== Action: ##objectremove## ==

458

459

Removes an XObject from the referenced page.

Examples:

* ##http:~/~/<server>/xwiki/bin/objectremove/Space/Page?classname=Some.XClass##

464

* ##http:~/~/<server>/xwiki/bin/objectremove/Space/Page?classname=XWiki.XWikiGroups&XWiki.XWikiGroups_member=XWiki.JohnDoe##

465

466

=== Parameter: ##classname## ===

467

468

The full name of the document that holds the class which the object to be removed should be instance of. Example: ##XWiki.XWikiGroups##.

469

470

=== Parameter: ##classid## ===

471

472

The number of the object to remove from the class (starts at 0).

473

474

=== Parameter: ##xredirect## ===

475

476

Optional parameter indicating the URL to redirect to once the object has been removed.

477

478

For example: ##xredirect=/xwiki/bin/view/SomeSpace/SomePage##.

479

480

When not specified, you're redirected to the current page (the page specified in the URL) in ##edit## mode (##/edit/## action).

481

482

=== Parameter: ##form_token## ===

483

484

A mandatory anti-CSRF token string which can be provided by the [[CSRF API>>extensions:Extension.XWiki Platform - CSRF.WebHome]].

= Type: ##vfs## =

See [[VFS Resource>>extensions:Extension.VFS API]].

489

490

= Type: ##webjars## =

491

492

See [[WebJar Resource>>extensions:Extension.WebJars Integration]]

= Type: ##wiki## =

XWiki 7.2: Added support for Nested Spaces

498

499

500

The format is ##wiki/<wiki name>/<bin subpath>## where:

501

502

* ##<wiki name>##: the name of the subwiki, e.g. ##platform##.

503

* ##<bin subpath>##: the same path as for the ##bin## action (see above). For example, if you use ##http:~/~/<main wiki server>/xwiki/bin/download/XWiki/JohnDoe/john.png## you would use ##http:~/~/<main wiki server>/xwiki/wiki/<subwiki name>/download/XWiki/JohnDoe/john.png## to access the same attachment but located in a subwiki named ##<subwiki>##.

504

505

= Type: ##resources## =

506

507

Static template resources, e.g. ##http:~/~/<server>/xwiki/resources/js/prototype/prototype.js##.

= Type: ##skins## =

Static skin resources, e.g. ##http:~/~/<server>/xwiki/skins/flamingo/logo.png##.

= Type: ##temp## =

Deprecated since 8.3. Use the ##tmp## resource handler instead.

517

518

519

Dynamic temporary resources, bound to a specific document and a specific module.

520

521

The format is ##temp/<Space>/<Document>/<module>/<file.ext>##, where:

522

523

* ##<Space>## and ##<Document>## identify the target document; currently only the last part of the space is supported

524

* ##<module>## is the name of the module that generated the resource, a short string used for avoiding conflicts between different modules generating temporary files with the same name

525

* ##<file.ext>## is the name of the temporary file

526

527

== Parameter: ##force-download## ==

528

529

If set to ##1##, force the file to be downloaded instead of being opened in the browser (it sets the ##Content-Disposition## header to ##attachment##).

530

531

== Parameter: ##force-filename## ==

[since 9.0RC1]

If ##force-download## is set, the value of ##force-filename## is used in the ##Content-disposition## HTTP header to indicate the name of the file to the browser.

= Type: ##tmp## =

See [[Temporary Resource>>extensions:Extension.Temporary Resource API]]

540

541

= Type: ##authenticate## =

542

543

544