Wiki source code of Front-end Resources
Version 17.1 by Silvia Macovei on 2010/02/25
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
16.1 | 1 | {{info}}This section is a work in progress.{{/info}} |
 |
4.1 | 2 | |
 |
6.1 | 3 | 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: |
| |
16.1 | 4 | |
| |
6.1 | 5 | * External Libraries |
| 6 | * Internal components (Based or not on some of the external libraries) | ||
| |
5.1 | 7 | |
| |
6.1 | 8 | 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. |
| 9 | |||
| |
16.1 | 10 | 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 ##jsfx## plugin. For example, to request the inclusion of scriptaculous slider library, you can write, in [[XWiki Syntax 1.0>>Main.XWikiSyntax]]: |
| |
11.1 | 11 | |
| |
16.1 | 12 | {{code}}$xwiki.jsfx.use("js/scriptaculous/slider.js"){{/code}} |
| |
11.1 | 13 | |
| |
16.1 | 14 | In [[XWiki Syntax 2.0>>Main.XWikiSyntax]]: |
| |
11.1 | 15 | |
| |
16.1 | 16 | {{code}} |
| |
11.1 | 17 | {{velocity}} |
| 18 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 19 | {{/velocity}} | ||
| |
16.1 | 20 | {{/code}} |
| |
11.1 | 21 | |
| |
16.1 | 22 | The path you indicate to the ##jsfx## plugin is the relative path where the library can be found under the ##resources## directory of the XWiki webapp. Similarly to the ##jsfx## plugin, there is a ##ssfx## plugin that can be used to request the inclusion of CSS stylesheets files. |
| |
11.1 | 23 | |
| |
17.1 | 24 | = External resources = |
| |
6.1 | 25 | |
| |
11.1 | 26 | 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. |
| 27 | |||
| 28 | Hereunder is a table presenting some of the external libraries XWiki comes with: | ||
| 29 | |||
| |
17.1 | 30 | |image:prototype.gif |image:smartclient.png |
| 31 | |[[Prototype>>http://prototypejs.org]] is a //"JavaScript framework that aims to ease development of web applications"//. 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. |[[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]]. | ||
| |
9.1 | 32 | |
| |
6.1 | 33 | * Scriptaculous |
| |
5.1 | 34 | * YUI |
| 35 | |||
| |
17.1 | 36 | = Internal resources = |
| |
1.1 | 37 | |
| |
17.1 | 38 | == Front-end Components == |
| |
12.2 | 39 | |
| |
16.1 | 40 | * [[Modal Popup>>ModalPopup]] |
| 41 | * [[Confirmation Box>>ConfirmationBox]] | ||
| 42 | * [[LiveTable]] | ||
| 43 | * [[Auto Suggest Widget>>DevGuide.AutoSuggestWidget]] | ||
| |
12.2 | 44 | |
| |
17.1 | 45 | == JavaScript resources == |
| |
11.2 | 46 | |
| |
16.1 | 47 | * [[JavaScriptAPI]] |
| 48 | * [[XWiki RESTFul API>>Features.XWikiRESTfulAPI]] | ||
| |
11.2 | 49 | |
| |
17.1 | 50 | == StyleSheet resources == |
| |
11.2 | 51 | |
| |
16.1 | 52 | * [[Pagination>>Pagination]] |
| 53 | * [[Result List>>ListOfResults]] | ||
| 54 | * [[Search Box>>SearchBox]] | ||
| 55 | * [[Suggest Box>>SuggestBox]] |
