<
From version < 56.7 >
edited by Vincent Massol
on 2015/04/01
To version < 56.8 >
edited by Vincent Massol
on 2015/04/01
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -31,59 +31,21 @@
31 31  * ##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##
32 32  * ##view##: Display Entity content (wiki, page, space, attachment, object, property, etc) with the skin applied, e.g. ##http://<server>/xwiki/bin/view/Sandbox/WebHome##
33 33  * ##edit##: Edits wiki content (page, object, property, etc), e.g. ##http://<server>/xwiki/bin/edit/Sandbox/WebHome##
34 -* ##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##
34 +* ##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.
35 +* ##export##: Exports wiki pages to various formats (PDF, HTML, etc). See [[platform:Features.Exports]].
36 +* ##viewrev##: This action is the same as the ##view## action but allowing to address a given revision of the document asked.
35 35  
36 36  === Action: ##view## ===
37 37  
38 -The additional URL paths for the ##view## action is ##<space>/<page>##.
40 +The additional URL paths for the ##view## action is ##<space>/<page>?<query string>##.
39 39  
40 40  Examples:
41 41  * ##http://<server>/xwiki/bin/view/Sandbox/WebHome##: Views the ##Sandbox.WebHome## page.
42 42  
43 -== Type: ##wiki## ==
45 +Here are some of the supported query string parameters.
44 44  
45 -The format is ##wiki/<wiki name>/<bin subpath>## where:
46 -* ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
47 -* ##<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>##.
47 +==== Parameter: ##xpage## ====
48 48  
49 -== Type: ##resources## ==
50 -
51 -Static template resources, e.g. ##http://<server>/xwiki/resources/js/prototype/prototype.js##.
52 -
53 -== Type: ##skins## ==
54 -
55 -Static skin resources, e.g. ##http://<server>/xwiki/skins/flamingo/logo.png##.
56 -
57 -
58 -
59 -= Space =
60 -
61 -Any wiki page is located in what is called a "space".
62 -
63 -See [[platform:Features.Spaces]] for more details about spaces.
64 -
65 -= Page (OPTIONAL) =
66 -
67 -The page contains wiki contents, objects/classes and attachments.
68 -
69 -When no page is specified like in the url ##http:~/~/host/xwiki/bin/view/Space/ ## the "WebHome" page name is used.
70 -
71 -= Attachment (OPTIONAL) =
72 -
73 -This part indicates the attachment you want to download from a particular page.
74 -
75 -See [[platform:Features.Attachments]] for more details about attachments.
76 -
77 -= Query string (OPTIONAL) =
78 -
79 -== Standard parameters ==
80 -
81 -Some of the parameters in the URL have a "system" meaning depending of the action.
82 -
83 -=== ##view## Action ===
84 -
85 -==== xpage ====
86 -
87 87  * ##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:
88 88  ** ##raw=1##: Returns the page source as is without any formatting but XML-escaped
89 89  ** ##raw=2##: Returns the page source as is without any formatting (without any escaping)
... ... @@ -91,26 +91,36 @@
91 91  * ##xml##: print the exported form of a document. This is what you can find in the xar for each document.
92 92  * ##rev##: when specified, redirects to the ##viewrev## action (see below)
93 93  
94 -==== outputSyntax and outputSyntaxVersion ====
56 +==== Parameter: ##outputSyntax## and ##outputSyntaxVersion## ====
95 95  
96 -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##.
58 +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##.
97 97  
98 98  See [[extensions:Extension.Rendering Module]] for more details on renderers.
99 99  
100 -=== ##export## Action ===
62 +=== Action: ##viewrev## ===
101 101  
102 -See [[platform:Features.Exports]].
64 +==== Parameter: ##rev## ====
103 103  
104 -=== ##viewrev## Action ===
66 +The version to get, e.g. ##2.3## in ##http://<server>/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
105 105  
106 -This action is the same as the ##view## action but allowing to address a given revision of the document asked.
68 +=== Action: ##get## ===
107 107  
108 -* ##rev##: the version to get, e.g. ##2.3## in ##http:~/~/host/xwiki/bin/viewrev/MySpace/MyPage?rev=2.3##
109 -
110 110  === ##get## Action ===
111 111  
112 -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.
72 +==== Parameter: ##htmlHeaderAndFooter## ====
113 113  
114 -This action takes the following parameter:
74 +{{info}}Since 6.3RC1{{/info}} If ##htmlHeaderAndFooter=true## is passed then display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
115 115  
116 -* ##htmlHeaderAndFooter=true##: {{info}}Since 6.3RC1{{/info}} Display the HTML headers (##<html>##,##<head>##,##<body>##, etc...) and footers (##</body>##, ##</html>##, etc...).
76 +== Type: ##wiki## ==
77 +
78 +The format is ##wiki/<wiki name>/<bin subpath>## where:
79 +* ##<wiki name>##: the name of the subwiki, e.g. ##platform##.
80 +* ##<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>##.
81 +
82 +== Type: ##resources## ==
83 +
84 +Static template resources, e.g. ##http://<server>/xwiki/resources/js/prototype/prototype.js##.
85 +
86 +== Type: ##skins## ==
87 +
88 +Static skin resources, e.g. ##http://<server>/xwiki/skins/flamingo/logo.png##.

Get Connected