General Actions:
XWiki Explorer Widget Documentation
Last modified by Jean-Vincent Drean on 2009/03/31 17:29
XWiki Explorer Widget Documentation
Introduction
Since XWiki Enterprise 1.8.1, XWiki provide a JavaScript widget (based on SmartClient TreeGrid widget) that allows to browse a XWiki instance. This widget can be configured to allow browsing of a farm, a wiki or a space.Configuration parameters
| Name | Type (Values) |
|---|---|
| wiki | String ("all" or the name of a wiki database) |
| space | String (the name of a space within the wiki) |
| page | String (the name of a page within the space) |
| displaySuggest | boolean (true to display a suggest field at the bottom) |
| displayLinks | boolean (true to display links in tree nodes) |
| displayAttachments | boolean (true to display attachments under page nodes) |
| displayAttachmentsOnTop | boolean (true to display attachments before children nodes) |
Examples
Prerequisites
First you need to copy the following javascript includes:## Smartclient $xwiki.jsfx.use("js/smartclient/initsc.js", true)## $xwiki.jsfx.use("js/smartclient/modules/ISC_Core.js")## $xwiki.jsfx.use("js/smartclient/modules/ISC_Foundation.js")## $xwiki.jsfx.use("js/smartclient/modules/ISC_Containers.js")## $xwiki.jsfx.use("js/smartclient/modules/ISC_Grids.js")## $xwiki.jsfx.use("js/smartclient/modules/ISC_Forms.js")## $xwiki.jsfx.use("js/smartclient/modules/ISC_DataBinding.js")## $xwiki.jsfx.use("js/smartclient/skins/Enterprise/load_skin.js")## ## XWikiExplorer $xwiki.jsfx.use("js/xwiki/xwikiexplorer/xwikiexplorer.js", true)##
Farm
<div id="XWEWrapper" style="height:300px;margin-right:20px;padding-bottom:30px;"></div> <script> isc.XWETreeGrid.create({ defaultValue: "", htmlElement: "XWEWrapper", // Mandatory HTML wrapper. dataSource: isc.XWEDataSource.create({}), }).draw(); </script>
Wiki
isc.XWETreeGrid.create({
defaultValue: "",
htmlElement: "XWEWrapper", // Mandatory HTML wrapper.
dataSource: isc.XWEWikiDataSource.create({}),
}).draw();Space
isc.XWETreeGrid.create({
defaultValue: "",
htmlElement: "XWEWrapper", // Mandatory HTML wrapper.
dataSource: isc.XWESpaceDataSource.create({ space: "Main" }),
}).draw();Page
isc.XWETreeGrid.create({
defaultValue: "",
htmlElement: "XWEWrapper", // Mandatory HTML wrapper.
dataSource: isc.XWEPageDataSource.create({ space: "Main", page: "WebHome" }),
}).draw();