Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 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## (See [[how to modify the wiki descriptor>>manager:AdminGuide.EditWikiDescriptor]]).
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>>AdminGuide.AccessWiki]]. In path-based mode, the server is the address of the main wiki.
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>>AdminGuide.AccessWiki]]).
13 ** ##rest##: points to a [[REST Resource>>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 {{info}}
21 If you're interested in configuring the XWiki URLs, check the [[URL Architecture page>>URL Architecture]].
22 {{/info}}
23
24 = Type: ##bin## =
25
26 {{info}}
27 XWiki 7.2: Added support for Nested Spaces
28 {{/info}}
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##>>#HAction:skin]]: Dynamic Skin resource, e.g. ##http:~/~/<server>/xwiki/bin/skin/resources/uicomponents/search/searchSuggest.css##
35 * ##jsx##: [[Javascript Skin Extension>>DevGuide.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/jsx/AnnotationCode/Settings?language=en##
36 * ##ssx##: [[StyleSheet Skin Extension>>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##>>#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##>>#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##>>#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 * [[##viewrev##>>#HAction:viewrev]]: This action is the same as the ##view## action but allowing to address a given revision of the document asked.
44 * [[##create##>>#HAction:create]]: Provides the UI for creating new documents, e.g. ##http:~/~/<server>/xwiki/bin/create/Space/NewDocument##
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>##
49
50 Examples:
51
52 * ##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
56 Here are some of the supported query string parameters.
57
58 === Parameter: ##xpage## ===
59
60 * ##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:
61 ** ##raw=1##: Returns the page source as is without any formatting but XML-escaped
62 ** ##raw=2##: Returns the page source as is without any formatting (without any escaping)
63 ** ##htmlHeaderAndFooter=true##: {{info}}Since 6.3RC1{{/info}} Display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
64 ** ##outputTitle##: {{info}}Since 7.3M2{{/info}} If ##true## then also display the title in addition to the content. Defaults to ##false## if not specified.
65 * ##xml##: print the exported form of a document. This is what you can find in the xar for each document.
66 * ##rev##: when specified, redirects to the ##viewrev## action (see below)
67 * ##children##: {{info}}Since 7.2M3{{/info}} display a page that lists all the children of the document. You can also add the following parameters:
68 ** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism
69 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
70 * ##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:
71 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
72 * ##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:
73 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
74 * ##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:
75 ** ##id=someId##: add an HTML id to the hierarchy breadcrumb.
76 ** ##displayTitle=true|false##: display the title of the elements in the breadcrumb (default: true)
77 ** ##excludeSelf=true|false##: display the hierarchy without the page itself (default: false)
78 ** ##limit=##: maximum number of hierarchy elements displayed (default: none)
79 ** ##local=true|false##: do not display the main wiki reference for documents located in sub-wikis. (default: false)
80
81 === Parameter: ##outputSyntax## and ##outputSyntaxVersion## ===
82
83 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##.
84
85 See [[extensions:Extension.Rendering Module]] for more details on renderers.
86
87 === Parameter: ##viewer## ===
88
89 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.
90
91 * ##children##: {{info}}Since 7.2RC1{{/info}} display a page that lists all the children of the document. You can also add the following parameters:
92 ** ##hierarchy=parentchild##: do the same but display the children according to the (old) parent/child mechanism
93 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
94 * ##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:
95 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
96 * ##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:
97 ** ##displayHidden=true##: display the hidden documents (no matter what the user's configuration is)
98
99 == Action: ##viewrev## ==
100
101 === Parameter: ##rev## ===
102
103 The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
104
105 == Action: ##save## ==
106
107 The additional URL paths for the ##save## action is ##<space>/<page>?<query string>##.
108
109 Examples:
110
111 * ##http:~/~/<server>/xwiki/bin/save/Sandbox/WebHome##: Save the ##Sandbox.WebHome## page.
112
113 Here are some of the supported query string parameters.
114
115 === Parameter: ##creator## ===
116
117 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.
118
119 === Parameter: ##language## ===
120
121 Will target a specific language. You must use a specific 2-letters code (see [[I18N>>http://platform.xwiki.org/xwiki/bin/view/Features/I18N]]).
122
123 === Parameter: ##objectPolicy## ===
124
125 {{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]]):
126
127 * ##update##
128 ** Each custom parameter will update a property in an existing object of the current page.
129 ** If the custom parameter refers to a property or an object that don't exist, it will simply ignore it.
130 * ##updateOrCreate##
131 ** Each custom parameter will update a property in an existing object of the current page.
132 ** If the custom parameter refers to a property that doesn't exist, it will ignore it.
133 ** If the custom parameter refers to an object that doesn't exist, it will create it (and pad will ##null## objects if needed).(((
134 //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).
135 //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.
136 )))
137
138 === Parameter: ##parent## ===
139
140 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##.
141
142 === Parameter: ##syntaxId## ===
143
144 Specify which syntax is used for the content of the current page (see [[Supported syntaxes>>http://rendering.xwiki.org/xwiki/bin/view/Main/#HSupportedSyntaxes]]).
145
146 === Parameter: ##template## ===
147
148 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##.
149
150 === Parameter: ##title## ===
151
152 Allows you to modify the title of the page.
153
154 === Custom Parameters ===
155
156 Custom parameters have the format ##<Space>.<ClassPage>_<number>_<propertyname>## (e.g. ##XWiki.XWikiUsers_0_password## or ##XWiki.WatchListClass_3_interval##):
157
158 * ##<Space>## must refer to an existing space of the wiki
159 * ##<ClassPage>## must refer to a class
160 * ##<number>## is a positive number
161 * ##<propertyname>## is a name of a property of the class ##<Space>.<ClassPage>##
162
163 == Action: ##inline## ==
164
165 The additional URL paths for the ##inline## action is ##<space>/<page>?<query string>##.
166
167 Examples:
168
169 * ##http:~/~/<server>/xwiki/bin/inline/Sandbox/WebHome##: Edit in inline mode the ##Sandbox.WebHome## page.
170
171 For the supported query string parameters, you can refer to the [[##save## action>>#HAction:save]].
172
173 == Action: ##get## ==
174
175 === Parameter: ##htmlHeaderAndFooter## ===
176
177 {{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
178
179 == Action: ##download## ==
180
181 The additional URL paths for the ##download## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.
182
183 Example:
184
185 * ##http:~/~/<server>/xwiki/bin/download/Space1/Space2/WebHome/image.png##: Views the ##image.png## attachment located in the ##Space1.Space2.WebHome## page.
186
187 === Parameter: ##force-download## ===
188
189 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##).
190
191 == Action: ##create## ==
192
193 The additional URL paths for the create action is ##<space1>/.../<spaceN>/<page>?<query string>##.
194
195 Examples:
196
197 http:~/~/<server>/xwiki/bin/create/Space1/Space2/NewPage: UI for creating the Space1.Space2.NewPage document (also known as a terminal document).
198 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).
199 http:~/~/<server>/xwiki/bin/view/Main/WebHome: Generic UI for creating a new document (asking for location and document name since Main.WebHome already exists)
200
201 Here are some of the supported query string parameters.
202
203 === Parameter: ##spaceReference## ===
204
205 {{info}}Since 7.2M1{{/info}} A local reference string serialization of the space in which to create the new document, e.g. "Space1.Space2"
206
207 //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.
208
209 === Parameter: ##name## ===
210
211 {{info}}Since 7.2M1{{/info}} A string representing the name of the new entity, e.g. "NewDocument".
212
213 Depending on the type of document to create, this will be used as:
214
215 * a space name, when creating non-terminal documents, e.g. spaceReference=Space&name=Page results in creating "Space.Page.WebHome"
216 * a document name, when creating terminal documents, e.g. spaceReference=Space&name=Page&tocreate=terminal results in creating "Space.Page"
217
218 === Parameter: ##tocreate## ===
219
220 Accepted values:
221
222 * empty or not specified:
223 ** 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"
224 ** 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".
225 ** {{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".
226 * "terminal" - forces the new document to be a terminal document.
227 ** 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.
228 ** 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".
229 * "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".
230
231 === Parameter: ##template## ===
232
233 A string serialized document reference of the document to use as template when creating the new document.
234
235 If empty, the new document will be a blank page.
236
237 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.
238
239 This parameter has precedence over the ##templateprovider## parameter, meaning that if both are specified, the ##templateprovider## will be ignored.
240
241 === Parameter: ##templateprovider## ===
242
243 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.
244
245 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.
246 //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".
247
248 If empty, the new document will be a blank page.
249
250 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.##
251
252 If both this parameter and the ##template## parameter are specified, the ##template## parameter will be used instead of and this parameter will be ignored.
253
254 === Parameter: ##title## ===
255
256 A string to use as the title of the new document.
257
258 === Parameter: ##parent## ===
259
260 {{warning}}Deprecated since 7.2M1{{/warning}} A string serialized document reference of the document to use as parent for the new document.
261
262 === Parameter: ##space## ===
263
264 {{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.
265
266 //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".
267
268 === Parameter: ##pageName## ===
269
270 {{warning}}Deprecated since 7.2M1{{/warning}} A string representing the name of the new document. Example: "NewDocument"
271
272 //Note//: When using ##tocreate=space## in conjunction with the ##space## parameter, this parameter will be ignored and the document "<space>.WebHome" will be created.
273
274 == Action: ##skin## ==
275
276 Right now dynamic Skin Resources are handled as Entity Resources ([[which is not correct>>http://jira.xwiki.org/browse/XWIKI-12449]]).
277
278 The additional URL paths for the ##skin## action is
279
280 * ##<filesystem path to resource>?<optional query string>## for Filesystem-based Skins
281 * ##<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.
282 * ##<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.
283
284 Examples:
285
286 * ##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).
287 * ##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.
288 * ##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##
289 * ##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).
290 * ##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).
291
292 = Type: ##wiki## =
293
294 {{info}}
295 XWiki 7.2: Added support for Nested Spaces
296 {{/info}}
297
298 The format is ##wiki/<wiki name>/<bin subpath>## where:
299
300 * ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
301 * ##<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>##.
302
303 = Type: ##resources## =
304
305 Static template resources, e.g. ##http:~/~/<server>/xwiki/resources/js/prototype/prototype.js##.
306
307 = Type: ##skins## =
308
309 Static skin resources, e.g. ##http:~/~/<server>/xwiki/skins/flamingo/logo.png##.
310
311 = Type: ##temp## =
312
313 Dynamic temporary resources, bound to a specific document and a specific module.
314
315 The format is ##temp/<Space>/<Document>/<module>/<file.ext>##, where:
316
317 * ##<Space>## and ##<Document>## identify the target document; currently only the last part of the space is supported
318 * ##<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
319 * ##<file.ext>## is the name of the temporary file
320
321 == Parameter: ##force-download## ==
322
323 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##).

Get Connected