Wiki source code of FrontendResources
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 Front-end Resources | ||
| 2 | |||
| 3 | #info("This section is a work in progress.") | ||
| 4 | |||
| 5 | This sections aims to document all the front-end resources available in XWiki for application developers and for developers of the XWiki products. Front-end resources are of two main types: | ||
| 6 | * External Libraries | ||
| 7 | * Internal components (Based or not on some of the external libraries) | ||
| 8 | |||
| 9 | Front-end resources are mainly composed of JavaScript libraries, CSS stylesheets and their corresponding HTML reusable snippets (or velocity macro to output this snippet), and velocity macros. | ||
| 10 | |||
| 11 | Some of the resources presented in here are not included by default with all HTML-rendered wiki pages (it would be a lot too much things to send to the client!), you have to request their inclusion from a skin template or from the wiki page itself using the <tt>jsfx</tt> plugin. For example, to request the inclusion of scriptaculous slider library, you can write, in [XWiki Syntax 1.0>Main.XWikiSyntax]: | ||
| 12 | |||
| 13 | {code} | ||
| 14 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 15 | {code} | ||
| 16 | |||
| 17 | In [XWiki Syntax 2.0>Main.XWikiSyntax]: | ||
| 18 | |||
| 19 | {code} | ||
| 20 | {{velocity}} | ||
| 21 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 22 | {{/velocity}} | ||
| 23 | {code} | ||
| 24 | |||
| 25 | The path you indicate to the <tt>jsfx</tt> plugin is the relative path where the library can be found under the <tt>resources</tt> directory of the XWiki webapp. Similarly to the <tt>jsfx</tt> plugin, there is a <tt>ssfx</tt> plugin that can be used to request the inclusion of CSS stylesheets files. | ||
| 26 | |||
| 27 | 1.1 External resources | ||
| 28 | |||
| 29 | External resources are third party libraries bundled with the XWiki webapp as resources developers can use for their in-wiki applications or to enhance the wiki itself. Almost all of the (except prototype.js) are not included by default in HTML-rendered wiki pages. | ||
| 30 | |||
| 31 | Hereunder is a table presenting some of the external libraries XWiki comes with: | ||
| 32 | |||
| 33 | <table> | ||
| 34 | <tbody> | ||
| 35 | <tr> | ||
| 36 | <td width="50%"> | ||
| 37 | <img src="$doc.getAttachmentURL('prototype.gif')" /><br /> | ||
| 38 | [Prototype>http://prototypejs.org>_blank] is a <em>"JavaScript framework that aims to ease development of web applications"</em>. It extends the JavaScript native objects and browser objects providing utilities for Ajax, OOP-style classes, and so much more. Prototype is the only JavaScript library that is systematically shipped with any wiki page in XWiki. | ||
| 39 | </td> | ||
| 40 | <td> | ||
| 41 | <img src="$doc.getAttachmentURL('smartclient.png')" /><br /> | ||
| 42 | [Smartclient>http://www.smartclient.com/] is an AJAX RIA system to easily develop rich interface components. Using it in XWiki, you can build powerful front-end widgets that can leverage [XWiki's RESTful API>Features.XWikiRESTfulAPI]. | ||
| 43 | </td> | ||
| 44 | </tr> | ||
| 45 | </tbody> | ||
| 46 | </table> | ||
| 47 | |||
| 48 | * Scriptaculous | ||
| 49 | * YUI | ||
| 50 | |||
| 51 | 1.1 Internal resources | ||
| 52 | |||
| 53 | 1.1.1 Front-end Components | ||
| 54 | |||
| 55 | * [LiveTable] | ||
| 56 | |||
| 57 | 1.1.1 JavaScript resources | ||
| 58 | |||
| 59 | * [JavaScriptAPI] | ||
| 60 | * [XWiki RESTFul API>Features.XWikiRESTfulAPI] | ||
| 61 | |||
| 62 | 1.1.1 StyleSheet resources | ||
| 63 | |||
| 64 | * [Pagination>Pagination] | ||
| 65 | * [Result List>ListOfResults] | ||
| 66 | * [Search Box>SearchBox] | ||
| 67 | * [Suggest Box>SuggestBox] |
