Wiki source code of Standard URL Format
Version 1.1 by Thomas Mortagne on 2008/10/21
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | 1 URLs resolution | ||
2 | |||
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. | ||
4 | |||
5 | http://wiki1.xwiki.org/xwiki/bin/view/SomeSpace/SomePage/attachment.ext?param1=value1¶m2=value2 | ||
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". | ||
9 | |||
10 | 1.1 Host | ||
11 | * The first thing XWiki do to find the right wiki the URL is pointing to is by trying to find <tt>wiki1.xwiki.org</tt> in the list of wiki descriptors. | ||
12 | * I no descriptor can be found: | ||
13 | ** if the host is an IP (127.0.0.1, 85.65.12.36, etc.) XWiki goes to main wiki | ||
14 | ** if the first part of the host name (what is before the first point) is "www" XWiki goes to main wiki | ||
15 | ** if the first part of the host name match a wiki identifier XWiki goes to this wiki | ||
16 | |||
17 | 1.1 \[OPTIONNAL\] Application context | ||
18 | #warning("TODO") | ||
19 | |||
20 | 1.1 \[OPTIONNAL\]/bin/ | ||
21 | #warning("TODO") | ||
22 | |||
23 | |||
24 | 1.1 \[OPTIONNAL\] Action | ||
25 | XWiki use "action" identifiers to determine what is the goal a the user when going to a page. | ||
26 | |||
27 | For example if the action is "edit" XWiki will print a 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. | ||
28 | |||
29 | 1.1 Space | ||
30 | 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. | ||
31 | |||
32 | 1.1 Page | ||
33 | The page is what contains wiki contents and objects/classes and attachments. | ||
34 | |||
35 | 1.1 Attachment | ||
36 | This part indicate the attachment you want to download from a particular page. | ||
37 | |||
38 | 1.1 Parameters | ||
39 | Actions can use URL parameters to modify there action depending of there value. | ||
40 | |||
41 | For example you can make a velocity script that print the content of this value with: | ||
42 | {code} | ||
43 | The value of the parameter is: $request.param1 | ||
44 | {code} | ||
45 | if you have a parameter "param1=Hello World" the result will be | ||
46 | {code} | ||
47 | The value of the parameter is: Hello World | ||
48 | {code} |