Wiki source code of Front-end Resources
Version 22.1 by Vincent Massol on 2015/08/12
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | {{info}} | ||
| 6 | This section is a work in progress. | ||
| 7 | {{/info}} | ||
| 8 | |||
| 9 | This section 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: | ||
| 10 | |||
| 11 | * External Libraries | ||
| 12 | * Internal components (based or not on some of the external libraries) | ||
| 13 | |||
| 14 | 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. | ||
| 15 | |||
| 16 | Some of the resources presented in here are not included by default with all HTML-rendered wiki pages (it would be too much 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]]: | ||
| 17 | |||
| 18 | {{code}} | ||
| 19 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 20 | {{/code}} | ||
| 21 | |||
| 22 | In [[XWiki Syntax 2.0>>Main.XWikiSyntax]]: | ||
| 23 | |||
| 24 | {{code}} | ||
| 25 | {{velocity}} | ||
| 26 | $xwiki.jsfx.use("js/scriptaculous/slider.js") | ||
| 27 | {{/velocity}} | ||
| 28 | {{/code}} | ||
| 29 | |||
| 30 | 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. | ||
| 31 | |||
| 32 | = External resources = | ||
| 33 | |||
| 34 | XWiki Enterprise contains some third-party libraries bundled by default. | ||
| 35 | |||
| 36 | Hereunder is a table presenting some of the external libraries XWiki Enterprise comes with: | ||
| 37 | |||
| 38 | |=Library Name|=Description | ||
| 39 | |image:prototype.gif||[[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 much more. Prototype is the only JavaScript library that is systematically shipped with any wiki page in XWiki. | ||
| 40 | |image:smartclient.png|[[Smartclient>>http://www.smartclient.com/]] is an AJAX RIA system that allows the easy development of rich interface components. Using it in XWiki, you can build powerful front-end widgets that can leverage [[XWiki's RESTful API>>Features.XWikiRESTfulAPI]]. | ||
| 41 | | Scriptaculous| | ||
| 42 | | YUI| | ||
| 43 | | [[LiveValidation]]| | ||
| 44 | | JQuery| | ||
| 45 | | JQuery UI| | ||
| 46 | |||
| 47 | = Internal resources = | ||
| 48 | |||
| 49 | == Front-end Components == | ||
| 50 | |||
| 51 | * [[Modal Popup>>ModalPopup]] | ||
| 52 | * [[Confirmation Box>>ConfirmationBox]] | ||
| 53 | * [[LiveTable]] | ||
| 54 | * [[Auto Suggest Widget>>DevGuide.AutoSuggestWidget]] | ||
| 55 | * [[Notification Widget>>DevGuide.XWikiNotifications]] | ||
| 56 | * [[HTML5 Upload>>DevGuide.HTML5Upload]] | ||
| 57 | * [[Autosave>>DevGuide.Autosave]] | ||
| 58 | |||
| 59 | == JavaScript resources == | ||
| 60 | |||
| 61 | * [[JavaScriptAPI]] | ||
| 62 | * [[XWiki RESTFul API>>Features.XWikiRESTfulAPI]] | ||
| 63 | |||
| 64 | == StyleSheet resources == | ||
| 65 | |||
| 66 | * [[Pagination>>Pagination]] | ||
| 67 | * [[Result List>>ListOfResults]] | ||
| 68 | * [[Search Box>>SearchBox]] | ||
| 69 | * [[Suggest Box>>SuggestBox]] | ||
| 70 | * [[Special CSS Classes>>SpecialCSSClasses]] | ||
| 71 | * [[CSS classes used for icons>>StandardIconClasses]] | ||
| 72 | * Forms Layout Type: | ||
| 73 | ** [[Vertical Layout>>VerticalForms]] | ||
| 74 | ** [[Inline Layout>>InlineForms]] |
