source: server/trunk/web/root/templates/html/help/urls/index.html @ 258

Last change on this file since 258 was 258, checked in by stormi, 13 years ago

fix wording in help

  • Property svn:keywords set to Id
File size: 1.1 KB
Line 
1<!-- $Id$ -->
2
3<div class="sophie_help">
4<h1>Formating results</h1>
5
6<p>This page describe supporting URLs on the website.</p>
7
8<p>Normally all urls support output as:
9
10<ul>
11    <li><code>HTML</code> format</li>
12    <li><code>AJAX</code> format, IE <code>HTML</code> format w/o standard html
13    headers. This is usefull to include part of website using
14    <code>Javascript</code> code.</li>
15    <li><code>JSON</code> format</li>
16</ul>
17
18For <code>XMLRPC</code> functions, see <a href="[% c.uri_for('/help', 'xmlrpc') %]">XMLRPC
19    Help</a> page.
20</p>
21
22<p>The default output is of course <code>HTML</code> format, like any website
23would do.</p>
24
25<p>Alternative output is obtained by passing argument either as <code>POST</code>
26or <code>GET</code>:
27
28<ul>
29    <li>setting <code>json</code> for json output,</li>
30    <li>setting <code>ajax</code> for ajax output.</li>
31</ul>
32</p>
33
34<p>Examples:
35
36<pre>
37    [% c.uri_for('/distrib') %]
38    [% c.uri_for('/distrib', { ajax => 1 }) %]
39    [% c.uri_for('/distrib', { json => 1 }) %]
40</pre>
41</p>
42
43<p><b>NB:</b> Some URL don't support (yet) all output type.</p>
44
45<h1>Urls:</h1>
46
47[% c.model('Help::POD').urls_functions %]
48</div>
Note: See TracBrowser for help on using the repository browser.