Wiki source code of Standard URL Format

Last modified by Thomas Mortagne on 2019/10/18

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##. 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 {{info}}
21 If you're interested in configuring the XWiki URLs, check the [[URL Architecture page>>Documentation.DevGuide.Architecture.URL Architecture.WebHome]].
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##>>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 * [[##viewrev##>>platform:DevGuide.Standard URL Format#HAction:viewrev]]: This action is the same as the ##view## action but allowing to address a given revision of the document asked.
44 * [[##create##>>platform:DevGuide.Standard URL Format#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 * ##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## ===
106
107 Accepted values:
108
109 * ##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 ##/##.
113
114 Examples:
115
116 * ##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}}
123
124 Accepted values:
125
126 * ##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 == Action: ##viewrev## ==
133
134 === Parameter: ##rev## ===
135
136 The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
137
138 == Action: ##save## ==
139
140 The additional URL paths for the ##save## action is ##<space>/<page>?<query string>##.
141
142 Examples:
143
144 * ##http:~/~/<server>/xwiki/bin/save/Sandbox/WebHome##: Save the ##Sandbox.WebHome## page.
145
146 Here are some of the supported query string parameters.
147
148 === Parameter: ##creator## ===
149
150 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.
151
152 === Parameter: ##language## ===
153
154 Will target a specific language. You must use a specific 2-letters code (see [[I18N>>platform:Features.I18N]]).
155
156 === Parameter: ##objectPolicy## ===
157
158 {{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]]):
159
160 * ##update##
161 ** Each custom parameter will update a property in an existing object of the current page.
162 ** If the custom parameter refers to a property or an object that don't exist, it will simply ignore it.
163 * ##updateOrCreate##
164 ** Each custom parameter will update a property in an existing object of the current page.
165 ** If the custom parameter refers to a property that doesn't exist, it will ignore it.
166 ** If the custom parameter refers to an object that doesn't exist, it will create it (and pad will ##null## objects if needed).(((
167 //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).
168 //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.
169 )))
170
171 === Parameter: ##parent## ===
172
173 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##.
174
175 === Parameter: ##syntaxId## ===
176
177 Specify which syntax is used for the content of the current page (see [[Supported syntaxes>>http://rendering.xwiki.org/xwiki/bin/view/Main/#HSupportedSyntaxes]]).
178
179 === Parameter: ##template## ===
180
181 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##.
182
183 === Parameter: ##title## ===
184
185 Allows you to modify the title of the page.
186
187 === Custom Parameters ===
188
189 Custom parameters have the format ##<Space>.<ClassPage>_<number>_<propertyname>## (e.g. ##XWiki.XWikiUsers_0_password## or ##XWiki.WatchListClass_3_interval##):
190
191 * ##<Space>## must refer to an existing space of the wiki
192 * ##<ClassPage>## must refer to a class
193 * ##<number>## is a positive number
194 * ##<propertyname>## is a name of a property of the class ##<Space>.<ClassPage>##
195
196 == Action: ##inline## ==
197
198 The additional URL paths for the ##inline## action is ##<space>/<page>?<query string>##.
199
200 Examples:
201
202 * ##http:~/~/<server>/xwiki/bin/inline/Sandbox/WebHome##: Edit in inline mode the ##Sandbox.WebHome## page.
203
204 For the supported query string parameters, you can refer to the [[##save## action>>platform:DevGuide.Standard URL Format#HAction:save]].
205
206 == Action: ##get## ==
207
208 === Parameter: ##htmlHeaderAndFooter## ===
209
210 {{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
211
212 == Action: ##download## ==
213
214 The additional URL paths for the ##download## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.
215
216 Example:
217
218 * ##http:~/~/<server>/xwiki/bin/download/Space1/Space2/WebHome/image.png##: Views the ##image.png## attachment located in the ##Space1.Space2.WebHome## page.
219
220 === Parameter: ##force-download## ===
221
222 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##).
223
224 == Action: ##downloadrev## ==
225
226 The additional URL paths for the ##downloadrev## action is ##<space1>/.../<spaceN>/<page>/<attachment>?<query string>##.
227
228 Example:
229
230 * ##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.
231
232 === Parameter: ##rev## ===
233
234 The version to get, e.g. ##1.2## in ##http:~/~/<server>/xwiki/bin/downloadrev/Space1/Space2/WebHome/image.png?rev=1.2##
235
236 === Parameter: ##force-download## ===
237
238 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##).
239
240 == Action: ##create## ==
241
242 The additional URL paths for the create action is ##<space1>/.../<spaceN>/<page>?<query string>##.
243
244 Examples:
245
246 http:~/~/<server>/xwiki/bin/create/Space1/Space2/NewPage: UI for creating the Space1.Space2.NewPage document (also known as a terminal document).
247 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).
248 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)
249
250 Here are some of the supported query string parameters.
251
252 === Parameter: ##spaceReference## ===
253
254 {{info}}Since 7.2M1{{/info}} A local reference string serialization of the space in which to create the new document, e.g. "Space1.Space2"
255
256 //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.
257
258 === Parameter: ##name## ===
259
260 {{info}}Since 7.2M1{{/info}} A string representing the name of the new entity, e.g. "NewDocument".
261
262 Depending on the type of document to create, this will be used as:
263
264 * a space name, when creating non-terminal documents, e.g. spaceReference=Space&name=Page results in creating "Space.Page.WebHome"
265 * a document name, when creating terminal documents, e.g. spaceReference=Space&name=Page&tocreate=terminal results in creating "Space.Page"
266
267 === Parameter: ##tocreate## ===
268
269 Accepted values:
270
271 * empty or not specified:
272 ** 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"
273 ** 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".
274 ** {{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".
275 * "terminal" - forces the new document to be a terminal document.
276 ** 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.
277 ** 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".
278 * "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".
279
280 === Parameter: ##template## ===
281
282 A string serialized document reference of the document to use as template when creating the new document.
283
284 If empty, the new document will be a blank page.
285
286 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.
287
288 This parameter has precedence over the ##templateprovider## parameter, meaning that if both are specified, the ##templateprovider## will be ignored.
289
290 === Parameter: ##templateprovider## ===
291
292 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.
293
294 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.
295 //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".
296
297 If empty, the new document will be a blank page.
298
299 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.##
300
301 If both this parameter and the ##template## parameter are specified, the ##template## parameter will be used instead of and this parameter will be ignored.
302
303 === Parameter: ##title## ===
304
305 A string to use as the title of the new document.
306
307 === Parameter: ##parent## ===
308
309 {{warning}}Deprecated since 7.2M1{{/warning}} A string serialized document reference of the document to use as parent for the new document.
310
311 === Parameter: ##space## ===
312
313 {{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.
314
315 //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".
316
317 === Parameter: ##pageName## ===
318
319 {{warning}}Deprecated since 7.2M1{{/warning}} A string representing the name of the new document. Example: "NewDocument"
320
321 //Note//: When using ##tocreate=space## in conjunction with the ##space## parameter, this parameter will be ignored and the document "<space>.WebHome" will be created.
322
323 == Action: ##skin## ==
324
325 Right now dynamic Skin Resources are handled as Entity Resources ([[which is not correct>>https://jira.xwiki.org/browse/XWIKI-12449]]).
326
327 The additional URL paths for the ##skin## action is
328
329 * ##<filesystem path to resource>?<optional query string>## for Filesystem-based Skins
330 * ##<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.
331 * ##<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.
332
333 Examples:
334
335 * ##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).
336 * ##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.
337 * ##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##
338 * ##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).
339 * ##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).
340
341 = Type: ##wiki## =
342
343 {{info}}
344 XWiki 7.2: Added support for Nested Spaces
345 {{/info}}
346
347 The format is ##wiki/<wiki name>/<bin subpath>## where:
348
349 * ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
350 * ##<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>##.
351
352 = Type: ##resources## =
353
354 Static template resources, e.g. ##http:~/~/<server>/xwiki/resources/js/prototype/prototype.js##.
355
356 = Type: ##skins## =
357
358 Static skin resources, e.g. ##http:~/~/<server>/xwiki/skins/flamingo/logo.png##.
359
360 = Type: ##temp## =
361
362 Dynamic temporary resources, bound to a specific document and a specific module.
363
364 The format is ##temp/<Space>/<Document>/<module>/<file.ext>##, where:
365
366 * ##<Space>## and ##<Document>## identify the target document; currently only the last part of the space is supported
367 * ##<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
368 * ##<file.ext>## is the name of the temporary file
369
370 == Parameter: ##force-download## ==
371
372 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##).
373
374 == Parameter: ##force-filename## ==
375
376 [since 9.0RC1]
377
378 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.
379
380 = Resource Handler based types =
381
382 Since 6.1 any extension can dynamically register (as components) "resource handlers" (not to mix with the "resources" type).
383
384 See [[known resource types>>extensions:Extension.Resource API#\#HKnownResourceTypes]]

Get Connected