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>>platform: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>>platform:Main.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>>platform:AdminGuide.AccessWiki]]).

13

** ##rest##: points to a [[REST Resource>>platform: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>>platform: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>##. The full list of ##<action>## is defined in the Strut Configuration file (located in ##WEB-INF/struts-config##).

31

32

Here are some well-known actions:

33

34

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

35

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

36

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

37

* ##webjars##: URL when [[accessing some resources located in a WebJar>>extensions:Extension.WebJars Integration]], e.g. ##http:~/~/<server>/xwiki/bin/webjars/resources/path?value=requirejs%2F2.1.15%2Frequire.min.js##

38

* [[##download##>>platform:DevGuide.Standard URL Format#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##

39

* [[##view##>>platform:DevGuide.Standard URL Format#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##

40

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

41

* [[##get##>>platform:DevGuide.Standard URL Format#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.

42

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

43

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

44

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

45

46

== Action: ##view## ==

47

48

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.

53

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

54

* ##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).

55

* ##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).

56

* ##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).

57

58

Here are some of the supported query string parameters.

59

60

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

61

62

* ##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:

63

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

64

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

65

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

66

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

67

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

68

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

69

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

70

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

71

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

72

* ##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:

73

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

74

* ##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:

75

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

76

* ##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:

77

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

78

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

79

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

80

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

81

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

82

83

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

84

85

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##.

86

87

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

88

89

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

90

91

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.

92

93

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

94

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

95

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

96

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

97

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

98

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

99

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

100

* ##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:

101

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

102

* ##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:

103

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

104

105

=== 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.

110

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

111

112

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).

117

* ##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).

118

* ##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.

119

120

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

121

122

{{info}}Since 11.5RC1{{/info}}

Accepted values:

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

127

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

128

129

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.

130

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

131

132

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

133

134

{{info}}Since 13.0.{{/info}}

135

136

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

137

138

== Action: ##viewrev## ==

139

140

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

141

142

{{warning}}Deprecated since 13.0. Use ##view## action instead.{{/warning}}

143

144

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

145

146

== Action: ##save## ==

147

148

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.

153

154

Here are some of the supported query string parameters.

155

156

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

157

158

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.

159

160

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

161

162

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

163

164

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

165

166

{{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>>platform:DevGuide.Standard URL Format#HCustomParameters]]):

167

168

* ##update##

169

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

170

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

171

* ##updateOrCreate##

172

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

173

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

174

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

175

//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).

176

//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.

177

)))

178

179

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

180

181

{{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##.

182

183

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

184

185

{{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##.

186

187

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

188

189

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##.

190

191

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

192

193

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

194

195

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

196

197

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##.

198

199

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

200

201

Allows you to modify the title of the page.

202

203

=== Custom Parameters ===

204

205

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

206

207

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

208

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

209

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

210

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

211

212

== Action: ##inline## ==

213

214

{{warning}}Deprecated since 3.2.{{/warning}}

215

216

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.

221

222

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

223

224

== Action: ##get## ==

225

226

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

227

228

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

229

230

== Action: ##download## ==

231

232

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.

237

238

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

239

240

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##).

241

242

== Action: ##downloadrev## ==

243

244

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.

249

250

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

251

252

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

253

254

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

255

256

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##).

257

258

== Action: ##create## ==

259

260

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).

265

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).

266

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)

267

268

Here are some of the supported query string parameters.

269

270

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

271

272

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

273

274

//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.

275

276

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

277

278

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

279

280

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

281

282

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

283

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

284

285

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

Accepted values:

* empty or not specified:

290

** 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"

291

** 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".

292

** {{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".

293

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

294

** 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.

295

** 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".

296

* "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".

297

298

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

299

300

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

301

302

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

303

304

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.

305

306

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

307

308

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

309

310

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.

311

312

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.

313

//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".

314

315

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

316

317

If not specified, and existing template providers are available to choose from in the current space and the ##template# parmeter 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.##

318

319

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

320

321

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

322

323

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

324

325

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

326

327

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

328

329

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

330

331

{{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.

332

333

//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".

334

335

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

336

337

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

338

339

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

340

341

== Action: ##skin## ==

342

343

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

344

345

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

346

347

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

348

* ##<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.

349

* ##<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).

354

* ##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.

355

* ##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##

356

* ##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).

357

* ##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).

358

359

== Action: ##objectadd## =

360

361

Adds an XObject to the referenced page.

362

363

Examples:

364

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

365

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

366

367

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

368

369

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

370

371

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

372

373

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).

= Type: ##wiki## =

XWiki 7.2: Added support for Nested Spaces

379

380

381

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

382

383

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

384

* ##<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>##.

385

386

= Type: ##resources## =

387

388

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## =

{{warning}}Deprecated since 8.3. Use the ##tmp## resource handler instead.{{/warning}}

397

398

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

399

400

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

401

402

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

403

* ##<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

404

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

405

406

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

407

408

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##).

409

410

== 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.

415

416

= Resource Handler based types =

417

418

Since 6.1 any extension can dynamically register (as components) "resource handlers" (not to mix with the "resources" type).

419

420

See [[known resource types>>extensions:Extension.Resource API#\#HKnownResourceTypes]]