Wiki source code of Front-end Resources
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{info}}This section is a work in progress.{{/info}} | ||
| 2 | |||
| 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: | ||
| 4 | |||
| 5 | * External Libraries | ||
| 6 | * Internal components (Based or not on some of the external libraries) | ||
| 7 | |||
| 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 | |||
| 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 | |||
| 12 | {{code}}$xwiki.jsfx.use("js/scriptaculous/slider.js"){{/code}} | ||
| 13 | |||
| 14 | In [[XWiki Syntax 2.0>>Main.XWikiSyntax]]: | ||
| 15 | |||
| 16 | {{code}} | ||
| 17 | {{velocity}} | ||
| 18 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 19 | {{/velocity}} | ||
| 20 | {{/code}} | ||
| 21 | |||
| 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. | ||
| 23 | |||
| 24 | = External resources = | ||
| 25 | |||
| 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 | |||
| 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]]. | ||
| 32 | |||
| 33 | * Scriptaculous | ||
| 34 | * YUI | ||
| 35 | * [[LiveValidation]] | ||
| 36 | |||
| 37 | = Internal resources = | ||
| 38 | |||
| 39 | == Front-end Components == | ||
| 40 | |||
| 41 | * [[Modal Popup>>ModalPopup]] | ||
| 42 | * [[Confirmation Box>>ConfirmationBox]] | ||
| 43 | * [[LiveTable]] | ||
| 44 | * [[Auto Suggest Widget>>DevGuide.AutoSuggestWidget]] | ||
| 45 | |||
| 46 | == JavaScript resources == | ||
| 47 | |||
| 48 | * [[JavaScriptAPI]] | ||
| 49 | * [[XWiki RESTFul API>>Features.XWikiRESTfulAPI]] | ||
| 50 | |||
| 51 | == StyleSheet resources == | ||
| 52 | |||
| 53 | * [[Pagination>>Pagination]] | ||
| 54 | * [[Result List>>ListOfResults]] | ||
| 55 | * [[Search Box>>SearchBox]] | ||
| 56 | * [[Suggest Box>>SuggestBox]] |
