<
From version < 48.2 >
edited by Vincent Massol
on 2009/12/15
To version < 49.1 >
edited by Silvia Macovei
on 2010/03/04
>
Change comment: Document converted from syntax xwiki/1.0 to syntax xwiki/2.0

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.SilviaRusu
Syntax
... ... @@ -1,1 +1,1 @@
1 -XWiki 1.0
1 +XWiki 2.0
Content
... ... @@ -1,109 +1,114 @@
1 -1 URLs resolution
1 += URLs resolution =
2 2  
3 +{{velocity filter="none"}}
4 +{{html clean="false" wiki="true"}}
3 3  #startfloatingbox()
4 -*Content*
5 -#toc("" "" "")
6 +**Content**
7 +
8 +{{toc start="" depth="" numbered=""/}}
6 6  #endfloatingbox()
10 +{{/html}}
11 +{{/velocity}}
7 7  
8 8  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.
9 9  
10 -{image:url.png}
15 +[[image:url.png]]
11 11  
12 -1.1 Protocol
17 +== Protocol ==
18 +
13 13  By default "http" is used when generating an url in XWiki.
14 14  
15 -In virtual mode, you can set "secure" parameter to true in a wiki descriptor to generate urls with "https" instead of "http". See [How to edit wiki descriptor>manager:AdminGuide.EditWikiDescriptor].
21 +In virtual mode, you can set "secure" parameter to true in a wiki descriptor to generate urls with "https" instead of "http". See [[How to edit wiki descriptor>>manager:AdminGuide.EditWikiDescriptor]].
16 16  
23 +== Host ==
17 17  
25 +In virtual mode it is used to determine the wiki to access. See [[manager:AdminGuide.AccessWiki#HThedomainnamebasedwikiaccess]] for more details.
18 18  
19 -
20 -1.1 Host
21 -
22 -In virtual mode it is used to determine the wiki to access. See [manager:AdminGuide.AccessWiki#HThedomainnamebasedwikiaccess] for more details.
23 -
24 24  In non-virtual mode is has no effect.
25 25  
26 -1.1 Application context (OPTIONAL)
29 +== Application context (OPTIONAL) ==
27 27  
28 -See [platform:Main.ShortURLs#HApplicationname] for more details on how to remove this part of the url.
31 +See [[platform:Main.ShortURLs#HApplicationname]] for more details on how to remove this part of the url.
29 29  
30 30  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.
31 31  
32 -1.1 Servlet mapping name (OPTIONAL)
35 +== Servlet mapping name (OPTIONAL) ==
33 33  
34 -See [platform:Main.ShortURLs#HServletmappingname] for more details on how to remove this part of the url.
37 +See [[platform:Main.ShortURLs#HServletmappingname]] for more details on how to remove this part of the url.
35 35  
36 36  This is used by the container to call the right servlet.
37 37  
38 38  It can be:
42 +
39 39  * /bin/: this calls the Struts servlet which will calls the right action for the following part of the URL.
40 -* /wiki/\[wikialias\]: call the same servlet but will be use to determine the subwiki to access 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. See [manager:AdminGuide.AccessWiki#HTheURLpatchbasedwikiaccess] for more details.
41 -* /xmlrpc/: call xmlrpc servlet. See [platform:Features.XMLRPC] for more details.
42 -* /webdav/: call webdav servlet. See [platform:Features.WebDAV] for more details.
43 -* /rest/: call REST servlet. . See [platform:Features.XWikiRESTfulAPI] for more details.
44 +* /wiki/[[wikialias]]: call the same servlet but will be use to determine the subwiki to access if ##xwiki.virtiual.usepath## is enabled in ##xwiki.cfg##. Notes that you can change the "wiki" part with anything else using ##xwiki.virtual.usepath.servletpath## and by modifying web.xml to reflect the new Struts action name. See [[manager:AdminGuide.AccessWiki#HTheURLpatchbasedwikiaccess]] for more details.
45 +* /xmlrpc/: call xmlrpc servlet. See [[platform:Features.XMLRPC]] for more details.
46 +* /webdav/: call webdav servlet. See [[platform:Features.WebDAV]] for more details.
47 +* /rest/: call REST servlet. . See [[platform:Features.XWikiRESTfulAPI]] for more details.
44 44  
45 -1.1 Struts action (OPTIONAL)
49 +== Struts action (OPTIONAL) ==
46 46  
47 -See [platform:Main.ShortURLs#HStrutsactionname] more more details on how to remove this part of the url.
51 +See [[platform:Main.ShortURLs#HStrutsactionname]] more more details on how to remove this part of the url.
48 48  
49 -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.
53 +When the servlet mapping name is ##bin## or the value of ##xwiki.virtual.usepath.servletpath##, XWiki use "action" identifiers to determine what is the goal of the user when going to a page.
50 50  
51 51  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.
52 52  
53 -1.1 Space
57 +== Space ==
58 +
54 54  Any wiki pages is located in what is called a "space".
55 55  
56 -See [platform:Features.Spaces] for more details about spaces.
61 +See [[platform:Features.Spaces]] for more details about spaces.
57 57  
63 +== Page (OPTIONAL) ==
58 58  
59 -
60 -
61 -1.1 Page (OPTIONAL)
62 62  The page is what contains wiki contents, objects/classes and attachments.
63 63  
64 -If no page is specified like in the url <tt>http://host/xwiki/bin/view/Space/</tt> the "WebHome" page name is used.
67 +If no page is specified like in the url ##http://host/xwiki/bin/view/Space/## the "WebHome" page name is used.##
65 65  
66 -1.1 Attachment
69 +== Attachment ==
67 67  
68 68  This part indicate the attachment you want to download from a particular page.
69 69  
70 -See [platform:Features.Attachments] for more details about attachments.
71 -1.1 Query string
72 -1.1.1 Standard parameters
73 +See [[platform:Features.Attachments]] for more details about attachments.
73 73  
75 +== Query string ==
76 +
77 +=== Standard parameters ===
78 +
74 74  Some of the parameters in the URL have a "system" meaning depending of the context.
75 75  
76 -1.1.1.1 view mode
77 -1.1.1.1.1 xpage
81 +==== view mode ====
82 +
83 +===== xpage =====
84 +
78 78  * plain: this value indicate that only the content of the page is printed (no UI). With document not in 1.0 syntax you can control the output syntax using outputSyntax and outputSyntaxVersion.
79 79  * xml: print the exported form of a document. This is what you can find in the xar for each document.
80 80  
81 -1.1.1.1.1 outputSyntax and outputSyntaxVersion
82 -With non 1.0 syntax document its possible to explicitly indicate the renderer to use for the page content. For example with <tt>outputSyntax=plain</tt> you will get the result in plain text. <tt>outputSyntaxVersion</tt> is optional parameter, if it's not provided XWiki will search for the last version of the renderer for the given <tt>outputSyntax</tt> syntax name. Note that outputSyntax control only the document content output syntax, if you want only the document content you can use <tt>xpage=plain</tt>.
88 +===== outputSyntax and outputSyntaxVersion =====
83 83  
84 -See [code:Modules.RenderingModule] for more details on renderers.
90 +With non 1.0 syntax document its 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 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 control only the document content output syntax, if you want only the document content you can use ##xpage=plain##.
85 85  
86 -1.1.1.1 export mode
92 +See [[code:Modules.RenderingModule]] for more details on renderers.
87 87  
88 -See [platform:Features.Exports].
94 +==== export mode ====
89 89  
90 -1.1.1 Generic
96 +See [[platform:Features.Exports]].
97 +
98 +=== Generic ===
99 +
91 91  Actions can use URL parameters to modify there action depending of there value.
92 92  
93 93  For example you can make a velocity script that print the content of this value with:
94 -{code}
103 +
104 +{{code}}
95 95  The value of the parameter is: $request.param1
96 -{code}
106 +{{/code}}
107 +
97 97  if you have a parameter "param1=Hello World" the result will be
98 -{code}
109 +
110 +{{code}}
99 99  The value of the parameter is: Hello World
100 -{code}
112 +{{/code}}
101 101  
102 -See [platform:DevGuide.Scripting] for more details about scripting.
103 -
104 -
105 -
106 -
107 -
108 -
109 -
114 +See [[platform:DevGuide.Scripting]] for more details about scripting.

Get Connected