FrontendResources

Version 15.1 by Oana Florea on 2010/01/06
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Front-end Resources

This section is a work in progress.

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: 

  • External Libraries
  • Internal components (Based or not on some of the external libraries)

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. 

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:

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

In XWiki Syntax 2.0:

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

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.

External resources

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. 

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

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.FrontendResources.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

  • Scriptaculous
  • YUI

Internal resources

Front-end Components

JavaScript resources

StyleSheet resources

Tags:
   

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected