FrontendResources (XWiki.org)

= Front-end Resources =

{{info}}This section is a work in progress.{{/info}}

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

7

* External Libraries

8

* Internal components (Based or not on some of the external libraries)

9

10

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.

11

12

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]]:

13

14

{{code}}$xwiki.jsfx.use("js/scriptaculous/slider.js"){{/code}}

15

16

In [[XWiki Syntax 2.0>>Main.XWikiSyntax]]:

$xwiki.jsfx.use("js/scriptaculous/slider.js")

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.

25

26

== External resources ==

27

28

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.

29

30

Hereunder is a table presenting some of the external libraries XWiki comes with:

<table>

<tbody>

<tr>

[[Prototype>>http://prototypejs.org||target=_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.

</td>

<td>

[[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]].

</td>

</tr>

</tbody>

</table>