Wiki source code of Standard URL Format

Version 15.1 by Thomas Mortagne on 2008/12/10

Hide last authors
Thomas Mortagne 1.1 1 1 URLs resolution
3 In a single instance of XWiki you have many sections and the URLs need to reflect all that. This documentation details the way URLs are parsed by XWiki and what means each part of it.
Thomas Mortagne 6.1 5 {image:url.png}
Thomas Mortagne 1.1 6
7 1.1 Protocol
8 By default "http" is used when generating an url in XWiki. You can set "secure" parameter to true in a wiki descriptor to generate urls with "https" in "http".
Thomas Mortagne 2.1 10 See [How to edit wiki descriptor>manager:AdminGuide.EditWiki].
Thomas Mortagne 1.1 12 1.1 Host
Thomas Mortagne 3.1 13 * The first thing XWiki do to find the right wiki the URL is pointing to is by trying to find <tt></tt> in the list of wiki descriptors. Comparing with the content of field <tt>server</tt> in objects of class XWiki.XWikiServerClass
14 * If no descriptor can be found:
Thomas Mortagne 1.1 15 ** if the host is an IP (,, etc.) XWiki goes to main wiki
16 ** if the first part of the host name (what is before the first point) is "www" XWiki goes to main wiki
17 ** if the first part of the host name match a wiki identifier XWiki goes to this wiki
Thomas Mortagne 11.1 19 1.1 Application context (OPTIONAL)
Thomas Mortagne 1.1 20
Thomas Mortagne 14.1 21 See [platform:Main.ShortURLs#HApplicationname] for more details on how to remove this part of the url.
Thomas Mortagne 3.1 23 It's what the web container (jetty, tomcat, glassfish, etc.) use to find XWiki in all the web applications it contains. To remove it mainly depends on the possibilities and configuration of your web container.
Thomas Mortagne 1.1 24
Thomas Mortagne 14.1 25 1.1 Servlet mapping name (OPTIONAL)
Thomas Mortagne 1.1 26
Thomas Mortagne 14.1 27 See [platform:Main.ShortURLs#HServletmappingname] for more details on how to remove this part of the url.
Thomas Mortagne 1.1 28
Thomas Mortagne 14.1 29 This is used by the container to call the right servlet.
Thomas Mortagne 3.1 31 It can be:
32 * /bin/: it's the default action is none is specified. It calls the standard XWiki view to edit/view/delete wiki page etc.
33 * /wiki/wikialias: call the same servlet but will be use to determine the subwiki to acces if <tt>xwiki.virtiual.usepath</tt> is enabled in <tt>xwiki.cfg</tt>. Notes that you can change the "wiki" part with anything else using <tt>xwiki.virtual.usepath.servletpath</tt> and by modifying web.xml to reflect the new Struts action name. If the struts action name is the same that.
34 ** XWiki tries to match a wiki descriptor with the provided <tt>wikialias</tt> like it was a domain name
35 ** then if it can't find any wiki descriptor it search for it with <tt>wikialias</tt> as wiki name
Thomas Mortagne 7.1 36 * /xmlrpc/: call xmlrpc servlet.
Thomas Mortagne 9.1 37 * /webdav/: call webdav servlet. See [dev:Drafts.WebDAV] for more details.
Thomas Mortagne 15.1 38 * /skins/: acces skin files like javascript, css, images, etc.
39 * /yui/
40 * /tinymce/
41 * /wikieditor/
Thomas Mortagne 14.1 42 1.1 Struts action (OPTIONAL)
Thomas Mortagne 13.1 44 See [platform:Main.ShortURLs#HStrutsactionname] more more details on how to remove this part of the url.
Thomas Mortagne 3.1 45
Thomas Mortagne 14.1 46 When the servlet mapping name is <tt>bin</tt> or the value of <tt>xwiki.virtual.usepath.servletpath</tt>, XWiki use "action" identifiers to determine what is the goal of the user when going to a page.
Thomas Mortagne 3.1 47
Thomas Mortagne 14.1 48 For example if the action is "edit", XWiki will print an editor the user use to modify a page content but if the "view" action is used XWiki will execute the page content to print/render the content.
Thomas Mortagne 1.1 50 1.1 Space
51 All XWiki page are located in what is called a "space". You have only one level of space but you can indicate a "parent space" for a space.
53 1.1 Page
54 The page is what contains wiki contents and objects/classes and attachments.
56 1.1 Attachment
57 This part indicate the attachment you want to download from a particular page.
Thomas Mortagne 4.1 59 1.1 Query string
Thomas Mortagne 1.1 60 Actions can use URL parameters to modify there action depending of there value.
62 For example you can make a velocity script that print the content of this value with:
63 {code}
64 The value of the parameter is: $request.param1
65 {code}
66 if you have a parameter "param1=Hello World" the result will be
67 {code}
68 The value of the parameter is: Hello World
69 {code}
Thomas Mortagne 6.1 70

Get Connected