Hide last authors
Manuel Smeria 50.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Thomas Mortagne 1.1 4
Vincent Massol 57.2 5 The general format of XWiki URLs is {{code language="none"}}<protocol>://<server>/<context path>/<type>/<path>{{/code}}, where:
Vincent Massol 56.2 6
Thomas Mortagne 90.1 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]]
Thomas Mortagne 95.1 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]].
Vincent Massol 57.3 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.
Vincent Massol 56.2 10 * ##<type>##: the type of URL depending on the XWiki subsystem accessed. The following types are supported:
Vincent Massol 56.5 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).
Vincent Massol 88.3 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]]
Vincent Massol 57.4 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.
Vincent Massol 75.3 16 ** ##xmlrpc##: points to the now deprecated XMLRPC API (see [[extensions:Extension.XML-RPC Integration]] for more details).
Vincent Massol 56.5 17 ** ##webdav##: points to a WebDAV resource (see [[Web DAV>>platform:Features.WebDAV]] for more details).
Vincent Massol 56.2 18 * ##<path>##: the path completely depends on the ##<type>## used. See below for more details.
19
Vincent Massol 56.10 20 {{info}}
Marius Dumitru Florea 89.1 21 If you're interested in configuring the XWiki URLs, check the [[URL Architecture page>>Documentation.DevGuide.Architecture.URL Architecture.WebHome]].
Vincent Massol 56.10 22 {{/info}}
23
Vincent Massol 56.9 24 = Type: ##bin## =
Vincent Massol 56.2 25
Eduard Moraru 64.2 26 {{info}}
27 XWiki 7.2: Added support for Nested Spaces
28 {{/info}}
Vincent Massol 62.1 29
Thomas Mortagne 102.1 30 There are various ##bin## URLs. The generic format of ##bin## URLs is ##bin/<action>/<path>##.
31 There is two ways to inject actions:
Vincent Massol 56.2 32
Thomas Mortagne 102.1 33 * by implementing an [[Entity Resource Reference Handler>>Extension.Resource API||anchor="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
Vincent Massol 56.5 36 Here are some well-known actions:
Eduard Moraru 57.7 37
Vincent Massol 88.3 38 * [[##skin##>>platform:DevGuide.Standard URL Format#HAction:skin]]: Dynamic Skin resource, e.g. ##http:~/~/<server>/xwiki/bin/skin/resources/uicomponents/search/searchSuggest.css##
39 * ##jsx##: [[Javascript Skin Extension>>platform:DevGuide.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/jsx/AnnotationCode/Settings?language=en##
40 * ##ssx##: [[StyleSheet Skin Extension>>platform:DevGuide.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/ssx/AnnotationCode/Style?language=en##
41 * [[##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##
42 * [[##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##
Vincent Massol 57.6 43 * ##edit##: Edits wiki content (page, object, property, etc), e.g. ##http:~/~/<server>/xwiki/bin/edit/Sandbox/WebHome##
Vincent Massol 88.3 44 * [[##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.
Vincent Massol 56.8 45 * ##export##: Exports wiki pages to various formats (PDF, HTML, etc). See [[platform:Features.Exports]].
Vincent Massol 88.3 46 * [[##create##>>platform:DevGuide.Standard URL Format#HAction:create]]: Provides the UI for creating new documents, e.g. ##http:~/~/<server>/xwiki/bin/create/Space/NewDocument##
Vincent Massol 96.1 47 * [[##objectadd##>>platform:DevGuide.Standard URL Format#HAction:objectadd]]: Adds an XObject, e.g. ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=Some.XClass##
Vincent Massol 56.5 48
Vincent Massol 56.9 49 == Action: ##view## ==
Vincent Massol 56.7 50
Vincent Massol 62.1 51 The additional URL paths for the ##view## action is ##<space1>/.../<spaceN>/<page>?<query string>## or ##<space1>/.../<spaceN>?<query string>##
Vincent Massol 56.7 52
53 Examples:
Eduard Moraru 57.7 54
Vincent Massol 57.6 55 * ##http:~/~/<server>/xwiki/bin/view/Sandbox/WebHome##: Views the ##Sandbox.WebHome## page.
Vincent Massol 62.1 56 * ##http:~/~/<server>/xwiki/bin/view/Sandbox##: Views the ##Sandbox.WebHome## page.
Eduard Moraru 86.1 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).
Eduard Moraru 86.2 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).
Vincent Massol 56.7 60
Vincent Massol 56.8 61 Here are some of the supported query string parameters.
Vincent Massol 56.2 62
Vincent Massol 56.9 63 === Parameter: ##xpage## ===
Vincent Massol 56.2 64
Vincent Massol 77.1 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:
Vincent Massol 50.1 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)
Guillaume Delhumeau 55.1 68 ** ##htmlHeaderAndFooter=true##: {{info}}Since 6.3RC1{{/info}} Display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
Vincent Massol 77.1 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.
Vincent Massol 50.1 70 * ##xml##: print the exported form of a document. This is what you can find in the xar for each document.
Vincent Massol 51.1 71 * ##rev##: when specified, redirects to the ##viewrev## action (see below)
Guillaume Delhumeau 74.1 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:
Guillaume Delhumeau 71.1 73 ** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism
Guillaume Delhumeau 74.1 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)
Guillaume Delhumeau 75.1 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)
Guillaume Delhumeau 78.1 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:
Guillaume Delhumeau 76.1 80 ** ##id=someId##: add an HTML id to the hierarchy breadcrumb.
Guillaume Delhumeau 78.1 81 ** ##displayTitle=true|false##: display the title of the elements in the breadcrumb (default: true)
Guillaume Delhumeau 80.1 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)
Thomas Mortagne 44.1 85
Vincent Massol 56.9 86 === Parameter: ##outputSyntax## and ##outputSyntaxVersion## ===
Thomas Mortagne 44.1 87
Vincent Massol 56.8 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##.
Thomas Mortagne 48.1 89
Manuel Smeria 50.2 90 See [[extensions:Extension.Rendering Module]] for more details on renderers.
Thomas Mortagne 45.1 91
Guillaume Delhumeau 70.1 92 === Parameter: ##viewer## ===
93
Guillaume Delhumeau 72.1 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.
Guillaume Delhumeau 71.1 95
Vincent Massol 89.2 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##)
Guillaume Delhumeau 74.1 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:
Guillaume Delhumeau 70.1 101 ** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism
Guillaume Delhumeau 74.1 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)
Guillaume Delhumeau 75.1 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)
Guillaume Delhumeau 70.1 107
Eduard Moraru 86.1 108 === Parameter: ##spaceRedirect## ===
109
110 Accepted values:
Vincent Massol 88.1 111
Eduard Moraru 86.1 112 * ##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 ##/##.
116
117 Examples:
Vincent Massol 88.1 118
Eduard Moraru 86.1 119 * ##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).
Eduard Moraru 86.2 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).
Eduard Moraru 86.1 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
Simon Urli 92.1 123 === Parameter: ##restricted## ===
124
Thomas Mortagne 102.1 125 {{info}}
126 Since 11.5RC1
127 {{/info}}
Simon Urli 94.1 128
Simon Urli 92.1 129 Accepted values:
Simon Urli 93.1 130
Simon Urli 92.1 131 * ##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
Simon Urli 93.1 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.
Simon Urli 92.1 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
Thomas Mortagne 98.1 137 === Parameter: ##rev## ===
138
Thomas Mortagne 102.1 139 {{info}}
140 Since 13.0.
141 {{/info}}
Thomas Mortagne 98.1 142
143 The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
144
Vincent Massol 56.9 145 == Action: ##viewrev## ==
Thomas Mortagne 45.1 146
Vincent Massol 56.9 147 === Parameter: ##rev## ===
Silvia Macovei 49.1 148
Thomas Mortagne 102.1 149 {{warning}}
150 Deprecated since 13.0. Use ##view## action instead.
151 {{/warning}}
Silvia Macovei 49.1 152
Thomas Mortagne 98.1 153 The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
154
Jean SIMARD 56.11 155 == Action: ##save## ==
156
157 The additional URL paths for the ##save## action is ##<space>/<page>?<query string>##.
158
159 Examples:
Eduard Moraru 57.7 160
Vincent Massol 57.6 161 * ##http:~/~/<server>/xwiki/bin/save/Sandbox/WebHome##: Save the ##Sandbox.WebHome## page.
Jean SIMARD 56.11 162
163 Here are some of the supported query string parameters.
164
165 === Parameter: ##creator## ===
Eduard Moraru 57.7 166
Jean SIMARD 56.11 167 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.
168
169 === Parameter: ##language## ===
Eduard Moraru 57.7 170
Vincent Massol 88.6 171 Will target a specific language. You must use a specific 2-letters code (see [[I18N>>platform:Features.I18N]]).
Jean SIMARD 56.11 172
Jean SIMARD 56.12 173 === Parameter: ##objectPolicy## ===
Eduard Moraru 57.7 174
Vincent Massol 88.3 175 {{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]]):
Jean SIMARD 56.12 176
Eduard Moraru 57.7 177 * ##update##
178 ** Each custom parameter will update a property in an existing object of the current page.
179 ** If the custom parameter refers to a property or an object that don't exist, it will simply ignore it.
180 * ##updateOrCreate##
181 ** Each custom parameter will update a property in an existing object of the current page.
182 ** If the custom parameter refers to a property that doesn't exist, it will ignore it.
183 ** If the custom parameter refers to an object that doesn't exist, it will create it (and pad will ##null## objects if needed).(((
184 //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).
185 //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.
186 )))
187
Simon Urli 97.1 188 === Parameter: ##addedObjects## ===
189
190 {{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##.
191
192 === Parameter: ##deletedObjects## ===
193
194 {{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##.
195
Jean SIMARD 56.11 196 === Parameter: ##parent## ===
Eduard Moraru 57.7 197
Jean SIMARD 56.11 198 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##.
199
200 === Parameter: ##syntaxId## ===
Eduard Moraru 57.7 201
Jean SIMARD 56.11 202 Specify which syntax is used for the content of the current page (see [[Supported syntaxes>>http://rendering.xwiki.org/xwiki/bin/view/Main/#HSupportedSyntaxes]]).
203
204 === Parameter: ##template## ===
Eduard Moraru 57.7 205
Jean SIMARD 56.11 206 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##.
207
208 === Parameter: ##title## ===
Eduard Moraru 57.7 209
Jean SIMARD 56.11 210 Allows you to modify the title of the page.
211
Jean SIMARD 56.14 212 === Custom Parameters ===
Eduard Moraru 57.7 213
Jean SIMARD 56.14 214 Custom parameters have the format ##<Space>.<ClassPage>_<number>_<propertyname>## (e.g. ##XWiki.XWikiUsers_0_password## or ##XWiki.WatchListClass_3_interval##):
Eduard Moraru 57.7 215
Jean SIMARD 56.14 216 * ##<Space>## must refer to an existing space of the wiki
217 * ##<ClassPage>## must refer to a class
218 * ##<number>## is a positive number
219 * ##<propertyname>## is a name of a property of the class ##<Space>.<ClassPage>##
220
Jean SIMARD 56.15 221 == Action: ##inline## ==
Eduard Moraru 57.7 222
Thomas Mortagne 102.1 223 {{warning}}
224 Deprecated since 3.2.
225 {{/warning}}
Thomas Mortagne 98.1 226
Jean SIMARD 56.15 227 The additional URL paths for the ##inline## action is ##<space>/<page>?<query string>##.
228
229 Examples:
Eduard Moraru 57.7 230
Vincent Massol 57.6 231 * ##http:~/~/<server>/xwiki/bin/inline/Sandbox/WebHome##: Edit in inline mode the ##Sandbox.WebHome## page.
Jean SIMARD 56.15 232
Vincent Massol 88.3 233 For the supported query string parameters, you can refer to the [[##save## action>>platform:DevGuide.Standard URL Format#HAction:save]].
Jean SIMARD 56.15 234
Vincent Massol 56.9 235 == Action: ##get## ==
Vincent Massol 51.1 236
Vincent Massol 56.9 237 === Parameter: ##htmlHeaderAndFooter## ===
Oana Florea 52.1 238
Vincent Massol 56.8 239 {{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
Guillaume Delhumeau 53.1 240
Vincent Massol 61.1 241 == Action: ##download## ==
242
Vincent Massol 63.1 243 The additional URL paths for the ##download## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.
244
245 Example:
246
247 * ##http:~/~/<server>/xwiki/bin/download/Space1/Space2/WebHome/image.png##: Views the ##image.png## attachment located in the ##Space1.Space2.WebHome## page.
248
Vincent Massol 61.1 249 === Parameter: ##force-download## ===
250
251 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##).
252
Simon Urli 91.1 253 == Action: ##downloadrev## ==
254
255 The additional URL paths for the ##downloadrev## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.
256
257 Example:
258
259 * ##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.
260
261 === Parameter: ##rev## ===
262
263 The version to get, e.g. ##1.2## in ##http:~/~/<server>/xwiki/bin/downloadrev/Space1/Space2/WebHome/image.png?rev=1.2##
264
265 === Parameter: ##force-download## ===
266
267 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##).
268
Eduard Moraru 64.1 269 == Action: ##create## ==
270
271 The additional URL paths for the create action is ##<space1>/.../<spaceN>/<page>?<query string>##.
272
273 Examples:
274
275 http:~/~/<server>/xwiki/bin/create/Space1/Space2/NewPage: UI for creating the Space1.Space2.NewPage document (also known as a terminal document).
276 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).
Eduard Moraru 85.2 277 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)
Eduard Moraru 64.1 278
279 Here are some of the supported query string parameters.
280
281 === Parameter: ##spaceReference## ===
282
283 {{info}}Since 7.2M1{{/info}} A local reference string serialization of the space in which to create the new document, e.g. "Space1.Space2"
284
Eduard Moraru 64.2 285 //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.
Eduard Moraru 64.1 286
287 === Parameter: ##name## ===
288
Eduard Moraru 64.3 289 {{info}}Since 7.2M1{{/info}} A string representing the name of the new entity, e.g. "NewDocument".
Eduard Moraru 64.1 290
Eduard Moraru 64.3 291 Depending on the type of document to create, this will be used as:
292
293 * a space name, when creating non-terminal documents, e.g. spaceReference=Space&name=Page results in creating "Space.Page.WebHome"
294 * a document name, when creating terminal documents, e.g. spaceReference=Space&name=Page&tocreate=terminal results in creating "Space.Page"
295
Eduard Moraru 64.1 296 === Parameter: ##tocreate## ===
297
298 Accepted values:
Eduard Moraru 64.2 299
Eduard Moraru 64.3 300 * empty or not specified:
Eduard Moraru 64.5 301 ** 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"
302 ** 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".
303 ** {{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".
Eduard Moraru 64.1 304 * "terminal" - forces the new document to be a terminal document.
305 ** 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.
306 ** 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".
Eduard Moraru 64.4 307 * "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".
Eduard Moraru 64.1 308
Eduard Moraru 64.6 309 === Parameter: ##template## ===
310
311 A string serialized document reference of the document to use as template when creating the new document.
312
313 If empty, the new document will be a blank page.
314
315 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.
316
317 This parameter has precedence over the ##templateprovider## parameter, meaning that if both are specified, the ##templateprovider## will be ignored.
318
319 === Parameter: ##templateprovider## ===
320
321 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.
322
323 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.
324 //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".
325
326 If empty, the new document will be a blank page.
327
328 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.##
329
330 If both this parameter and the ##template## parameter are specified, the ##template## parameter will be used instead of and this parameter will be ignored.
331
Eduard Moraru 64.7 332 === Parameter: ##title## ===
333
334 A string to use as the title of the new document.
335
336 === Parameter: ##parent## ===
337
338 {{warning}}Deprecated since 7.2M1{{/warning}} A string serialized document reference of the document to use as parent for the new document.
339
Eduard Moraru 64.1 340 === Parameter: ##space## ===
341
342 {{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.
343
Eduard Moraru 64.2 344 //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".
Eduard Moraru 64.1 345
346 === Parameter: ##pageName## ===
347
348 {{warning}}Deprecated since 7.2M1{{/warning}} A string representing the name of the new document. Example: "NewDocument"
349
Eduard Moraru 64.2 350 //Note//: When using ##tocreate=space## in conjunction with the ##space## parameter, this parameter will be ignored and the document "<space>.WebHome" will be created.
Eduard Moraru 64.1 351
Vincent Massol 65.1 352 == Action: ##skin## ==
353
Thomas Mortagne 87.1 354 Right now dynamic Skin Resources are handled as Entity Resources ([[which is not correct>>https://jira.xwiki.org/browse/XWIKI-12449]]).
Vincent Massol 65.1 355
Vincent Massol 66.1 356 The additional URL paths for the ##skin## action is
Guillaume Delhumeau 68.1 357
Vincent Massol 66.1 358 * ##<filesystem path to resource>?<optional query string>## for Filesystem-based Skins
359 * ##<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.
360 * ##<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.
Vincent Massol 65.1 361
362 Examples:
363
Vincent Massol 67.1 364 * ##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).
Vincent Massol 65.1 365 * ##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.
Vincent Massol 67.1 366 * ##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##
367 * ##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).
368 * ##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).
Vincent Massol 65.1 369
Thomas Mortagne 102.1 370 == Action: ##objectadd## ==
Vincent Massol 96.1 371
372 Adds an XObject to the referenced page.
373
374 Examples:
Thomas Mortagne 102.1 375
Vincent Massol 96.1 376 * ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=Some.XClass##
377 * ##http:~/~/<server>/xwiki/bin/objectadd/Space/Page?classname=XWiki.XWikiGroups&XWiki.XWikiGroups_member=XWiki.JohnDoe##
378
379 === Parameter: ##classname## ===
380
381 The full name of the document that holds the class which the object to be added should be instance of. Example: ##XWiki.XWikiGroups##.
382
383 === Parameter: ##<classname>_<fieldname>## ===
384
385 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).
386
Vincent Massol 101.1 387 = Type: ##vfs## =
388
389 See [[VFS Resource>>extensions:Extension.VFS API]].
390
391 = Type: ##webjars## =
392
393 See [[WebJar Resource>>extensions:Extension.WebJars Integration]]
394
Vincent Massol 56.9 395 = Type: ##wiki## =
Vincent Massol 56.8 396
Eduard Moraru 64.2 397 {{info}}
398 XWiki 7.2: Added support for Nested Spaces
399 {{/info}}
Vincent Massol 62.1 400
Vincent Massol 56.8 401 The format is ##wiki/<wiki name>/<bin subpath>## where:
Eduard Moraru 57.7 402
Vincent Massol 56.8 403 * ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
Sergiu Dumitriu 81.1 404 * ##<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>##.
Vincent Massol 56.8 405
Vincent Massol 56.9 406 = Type: ##resources## =
Vincent Massol 56.8 407
Vincent Massol 57.6 408 Static template resources, e.g. ##http:~/~/<server>/xwiki/resources/js/prototype/prototype.js##.
Vincent Massol 56.8 409
Vincent Massol 56.9 410 = Type: ##skins## =
Vincent Massol 56.8 411
Vincent Massol 57.6 412 Static skin resources, e.g. ##http:~/~/<server>/xwiki/skins/flamingo/logo.png##.
Sergiu Dumitriu 81.1 413
414 = Type: ##temp## =
415
Thomas Mortagne 102.1 416 {{warning}}
417 Deprecated since 8.3. Use the ##tmp## resource handler instead.
418 {{/warning}}
Thomas Mortagne 98.1 419
Sergiu Dumitriu 81.1 420 Dynamic temporary resources, bound to a specific document and a specific module.
421
422 The format is ##temp/<Space>/<Document>/<module>/<file.ext>##, where:
423
424 * ##<Space>## and ##<Document>## identify the target document; currently only the last part of the space is supported
425 * ##<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
426 * ##<file.ext>## is the name of the temporary file
427
428 == Parameter: ##force-download## ==
429
430 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##).
Thomas Mortagne 84.1 431
432 == Parameter: ##force-filename## ==
433
434 [since 9.0RC1]
435
436 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.
Thomas Mortagne 85.1 437
Vincent Massol 101.1 438 = Type: ##tmp## =
Thomas Mortagne 85.1 439
Vincent Massol 101.1 440 See [[Temporary Resource>>extensions:Extension.Temporary Resource API]]

Get Connected