Scripting Documentation Application

Last modified by Thomas Mortagne on 2017/10/16 00:11

bookProvides integrated documentation of all available scripting API directly in your running wiki instance. You may also get additionnal API information at http://platform.xwiki.org/xwiki/bin/view/DevGuide/API
Recommended
TypeXAR
CategoryApplication
Developed by

Denis Gervalle

Active Installs95
Rating
Rate!
6 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

This application provides the documentation for the XWiki Scripting API. The documentation is dynamically generated based on the available bindings provided to scripts by the running wiki instance, and includes bindings provided by installed extensions. This documentation is based on the Scripting Documentation API to retrieve all informations about existing bindings.

scriptdoc1.png

Search interface

You may quickly search for available bindings from a text search box. You may also filter displayed bindings by categories. And finally you may also display deprecated and internal bindings if ever needed

scriptdoc2.png

Immediate description

Many bindings provides an immediate description about there usage, simply by moving the mouse over them.

scriptdoc3.png

Integrated browsing of the related Javadoc

The corresponding Javadoc for the chosen binding is displayed directly in the XWiki page, and you can freely navigate it using links and back/forward buttons (no iFrame involved).

scriptdoc4.png

Dynamic link creation for missing links in the Javadoc (since 1.1)

When crossing projects boundaries, the Javadoc does not provides links to very useful types. Here an example of a return values of a script service defined in platform project that returns a Type from commons project.

scriptdoc5.png

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise 6.4.1

Flamingo skin required. XWiki 6.2.x higher or equal to 6.2.5 is also mostly supported.

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

Release Notes

v1.1

  • Closed SCRIPTDOC-4 Add support for retrieving documentation for any loadable Java class
  • Closed SCRIPTDOC-3 Documentation links pointing to extensions.xwiki.org are not working anymore
  • Closed SCRIPTDOC-2 HTML errors in the wiki after installing Scripting Documentation App
  • Closed SCRIPTDOC-1 Clicking too fast on links in the documentation cause page not found failure

Dependencies

Dependencies for this extension (org.xwiki.contrib.scriptingdocumentation:scripting-documentation-ui 1.1):

Tags:
Created by Denis Gervalle on 2015/03/13 17:53
    

Get Connected