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 [[platform:Features.XMLRPC]] 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 URL schema, check the [[Short URL Tutorial>>Main.ShortURLs]].
22 {{/info}}
23
24 = Type: ##bin## =
25
26 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##).
27
28 Here are some well-known actions:
29
30 * ##skin##: Dynamic Skin resource, e.g. ##http:~/~/<server>/xwiki/bin/skin/skins/flamingo/style.css?skin=XWiki.DefaultSkin&colorTheme=playground%3AFlamingoThemes.Charcoal## or ##http:~/~/<server>/xwiki/bin/skin/resources/uicomponents/search/searchSuggest.css##
31 * ##jsx##: [[Javascript Skin Extension>>DevGuide.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/jsx/AnnotationCode/Settings?language=en##
32 * ##ssx##: [[StyleSheet Skin Extension>>DevGuide.SkinExtensionsTutorial]] URL, e.g. ##http:~/~/<server>/xwiki/bin/ssx/AnnotationCode/Style?language=en##
33 * ##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##
34 * ##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##
35 * ##view##: Display Entity content (wiki, page, space, attachment, object, property, etc) with the skin applied, e.g. ##http:~/~/<server>/xwiki/bin/view/Sandbox/WebHome##
36 * ##edit##: Edits wiki content (page, object, property, etc), e.g. ##http:~/~/<server>/xwiki/bin/edit/Sandbox/WebHome##
37 * ##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.
38 * ##export##: Exports wiki pages to various formats (PDF, HTML, etc). See [[platform:Features.Exports]].
39 * ##viewrev##: This action is the same as the ##view## action but allowing to address a given revision of the document asked.
40
41 == Action: ##view## ==
42
43 The additional URL paths for the ##view## action is ##<space>/<page>?<query string>##.
44
45 Examples:
46
47 * ##http:~/~/<server>/xwiki/bin/view/Sandbox/WebHome##: Views the ##Sandbox.WebHome## page.
48
49 Here are some of the supported query string parameters.
50
51 === Parameter: ##xpage## ===
52
53 * ##plain##: this value indicates that only the content of the page is printed (no UI). With a document that's not using the XWiki 1.0 syntax you can control the output syntax using ##outputSyntax## and ##outputSyntaxVersion##. You can also pass another parameter named ##raw## which allows you more control:
54 ** ##raw=1##: Returns the page source as is without any formatting but XML-escaped
55 ** ##raw=2##: Returns the page source as is without any formatting (without any escaping)
56 ** ##htmlHeaderAndFooter=true##: {{info}}Since 6.3RC1{{/info}} Display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
57 * ##xml##: print the exported form of a document. This is what you can find in the xar for each document.
58 * ##rev##: when specified, redirects to the ##viewrev## action (see below)
59
60 === Parameter: ##outputSyntax## and ##outputSyntaxVersion## ===
61
62 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##.
63
64 See [[extensions:Extension.Rendering Module]] for more details on renderers.
65
66 == Action: ##viewrev## ==
67
68 === Parameter: ##rev## ===
69
70 The version to get, e.g. ##2.3## in ##http:~/~/<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
71
72 == Action: ##save## ==
73
74 The additional URL paths for the ##save## action is ##<space>/<page>?<query string>##.
75
76 Examples:
77
78 * ##http:~/~/<server>/xwiki/bin/save/Sandbox/WebHome##: Save the ##Sandbox.WebHome## page.
79
80 Here are some of the supported query string parameters.
81
82 === Parameter: ##creator## ===
83
84 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.
85
86 === Parameter: ##language## ===
87
88 Will target a specific language. You must use a specific 2-letters code (see [[I18N>>http://platform.xwiki.org/xwiki/bin/view/Features/I18N]]).
89
90 === Parameter: ##objectPolicy## ===
91
92 {{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]]):
93
94 * ##update##
95 ** Each custom parameter will update a property in an existing object of the current page.
96 ** If the custom parameter refers to a property or an object that don't exist, it will simply ignore it.
97 * ##updateOrCreate##
98 ** Each custom parameter will update a property in an existing object of the current page.
99 ** If the custom parameter refers to a property that doesn't exist, it will ignore it.
100 ** If the custom parameter refers to an object that doesn't exist, it will create it (and pad will ##null## objects if needed).(((
101 //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).
102 //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.
103 )))
104
105 === Parameter: ##parent## ===
106
107 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##.
108
109 === Parameter: ##syntaxId## ===
110
111 Specify which syntax is used for the content of the current page (see [[Supported syntaxes>>http://rendering.xwiki.org/xwiki/bin/view/Main/#HSupportedSyntaxes]]).
112
113 === Parameter: ##template## ===
114
115 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##.
116
117 === Parameter: ##title## ===
118
119 Allows you to modify the title of the page.
120
121 === Custom Parameters ===
122
123 Custom parameters have the format ##<Space>.<ClassPage>_<number>_<propertyname>## (e.g. ##XWiki.XWikiUsers_0_password## or ##XWiki.WatchListClass_3_interval##):
124
125 * ##<Space>## must refer to an existing space of the wiki
126 * ##<ClassPage>## must refer to a class
127 * ##<number>## is a positive number
128 * ##<propertyname>## is a name of a property of the class ##<Space>.<ClassPage>##
129
130 == Action: ##inline## ==
131
132 The additional URL paths for the ##inline## action is ##<space>/<page>?<query string>##.
133
134 Examples:
135
136 * ##http:~/~/<server>/xwiki/bin/inline/Sandbox/WebHome##: Edit in inline mode the ##Sandbox.WebHome## page.
137
138 For the supported query string parameters, you can refer to the [[##save## action>>#HAction:save]].
139
140 == Action: ##get## ==
141
142 == ##get## Action ==
143
144 === Parameter: ##htmlHeaderAndFooter## ===
145
146 {{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
147
148 = Type: ##wiki## =
149
150 The format is ##wiki/<wiki name>/<bin subpath>## where:
151
152 * ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
153 * ##<bin spath>##: 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>##.
154
155 = Type: ##resources## =
156
157 Static template resources, e.g. ##http:~/~/<server>/xwiki/resources/js/prototype/prototype.js##.
158
159 = Type: ##skins## =
160
161 Static skin resources, e.g. ##http:~/~/<server>/xwiki/skins/flamingo/logo.png##.

Get Connected