Adds a toolbox of useful links to the UI

Description

Purpose

You might want to install this extension in one of the following scenarios

• You are a developper working on a custom skin that does not offer the "edit objects", "export", etc. commodity links
• You want to have quick access to links that are not offered by the standard skin

Sample usages

By default the extension is set as on demand. You can turn it to "always use" editing the XWiki.Toolbox JavaScript extension object. Alternatively, you might want to include it conditionnally, for example:

#if($isDevelopper)
$xwiki.jsx.use('XWiki.Toolbox')
#end

Where isDevelopper is a variable set by you according to group membership, or any strategy you find appropriate.

Another possibility is:

#if($environment == "dev")
$xwiki.jsx.use('XWiki.Toolbox')
#end

So that the toolbox appears only on your development site.

Edit/add links

You can change/remove/add links proposed by the toolbox. Edit the JavaScript extension in XWiki.Toolbox, and adapt the tools object for your needs.

Example of tool map:

  var tools = {
    "edit" : {
      "icon" : "$xwiki.getSkinFile('icons/silk/page_white_edit.gif')",
      "uri"  : XWiki.currentDocument.getURL('edit', 'editor=wiki')
    },
    "objects" : {
      "icon" : "$xwiki.getSkinFile('icons/silk/brick.gif')",
      "uri"  : XWiki.currentDocument.getURL('edit', 'editor=object')
    }
  }

Screenshot

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki