Previous
5.14.4 daisy-util.js API reference
To make the Daisy Wiki context and functionality easily available from flowscript (javascript), a small integration library called daisy-util.js is available.
5.14.4.1 Importing
To use it, add the following on top of the javascript file:
cocoon.load("resource://org/outerj/daisy/frontend/util/daisy-util.js");
5.14.4.2 The Daisy object
To avoid naming conflicts, all provided functions are wrapped in a "Daisy" object. To use any of the functions, get a reference to the Daisy object like this:
var daisy = getDaisy();
and then call the functions on the daisy object. The getDaisy() method returns a singleton instance of the Daisy object, so don't be afraid of calling it as often as you like (rather than passing the daisy instance around).
5.14.4.3 Functions
5.14.4.3.1 daisy.getRepository()
Returns the Repository object for the current user. Using the repository object, you can perform any repository operation, from creating documents to performing queries. See the javadoc API included in the binary Daisy distribution.
This is the method you should most often use, the methods below are for special cases.
5.14.4.3.2 daisy.getRepository(login, password)
Returns the Repository object for an arbitrary user.
5.14.4.3.3 daisy.getGuestRepository()
Returns the Repository object for the guest user. This can be useful if you want to do something specifically as guest.
If the current user is "not logged in" (which means, is automatically logged in as guest user), you can simply use the getRepository() method.
5.14.4.3.4 daisy.getPageContext(repository)
The repository argument is optional, by default the repository object of the current user will be used.
The PageContext object is an object encapsulating various context information
and is streamable as XML. An instance of PageContext is usually passed on to the
view layer and streamed by a JX template (see the ${pageContext} in the
JX templates). This automatically generates the context element that is required
as
5.14.4.3.5 daisy.resolve(uri)
Resolves an URL to a more absolute form. There is nothing Daisy-specific about this method, but this can be useful when reusing a pipeline from the main Daisy Wiki sitemap while specifying a file located in the current extension. This is used in the guestbook sample.
5.14.4.3.6 daisy.getHTMLCleaner(configFilePath)
Returns a HTMLCleaner object. The configFilePath is optional, and specifies the path to a htmlcleaner.xml file. By default, the default htmlcleaner.xml of the Daisy Wiki will be used.
The HTMLCleaner object allows to clean up and normalize HTML in the same way as is otherwise done when editing through the default document editing screen. The most common usage is:
var daisy = getDaisy(); var content = "<html><body>Hello world!</body></html>"; var htmlcleaner = daisy.getHTMLCleaner(); var data = htmlcleaner.cleanToByteArray(content);
The data object, which is a Java byte array, can then be supplied to the setPart() method of the document object (see the repository API javadoc).
5.14.4.3.7 daisy.performPublisherRequest(pipe, params, publishType, repository)
Performs a
The publisher request built from the pipeline is then executed by the publisher.
If the request contained any <p:preparedDocuments> elements having an attribute applyDocumentTypeStyling="true", then the prepared documents included in this element will be extracted, document type specific styling will be applied to them, and the result will be put aside in a request attribute for later merging by use of the DaisyIncludePreparedDocuments transformer.
The result of executing the publisher is returned as a SAXBuffer object, this is an object which can easily be streamed in a pipeline using the JX template generator (or a file generator with src="xmodule:flow-attr:something").
The publishType argument identifies the kind of document type specific styling that should be applied, this is either html or xslfo. This argument is only relevant if the publisher request contains any <p:preparedDocuments applyDocumentTypeStyling="true"/> requests.
The repository argument is optional, by default the repository object of the current user is used.
5.14.4.3.8 daisy.buildPublisherRequest(pipe, params)
This builds a publisher request, the same way as is done by daisy.performPublisherRequest, but doesn't execute it. This can be useful for debugging purposes: call buildPublisherRequest with the same parameters as you would call performPublisherRequest, and dump it to, for example, the console:
var publisherRequest = daisy.buildPublisherRequest(pipe, params); java.lang.System.out.println(publisherRequest);
Of course, if you do this for debugging purposes, be sure to remove these calls afterwards!
BTW, for the curious, to execute the publisher request yourself, the scenario is like this:
var daisy = getDaisy();
var publisherRequest = daisy.buildPublisherRequest(....);
var repository = daisy.getRepository();
var publisher = repository.getExtension("Publisher");
publisher.processRequest(publisherRequest, ..some sax contenthandler..);
If you use the performPublisherRequest method, the "..some sax contenthandler.." will be a ContentHandler that automatically does the document type specific styling stuff.
5.14.4.3.9 daisy.getSiteConf()
Returns an object of the following type:
org.outerj.daisy.frontend.components.siteconf.SiteConf
for the current site. This allows access to various site parameters such as its default collection.
5.14.4.3.10 daisy.getMountPoint()
Returns the part of the URL path leading to the main Daisy sitemap (thus, up until where the URLs are interpreted by the Daisy Wiki). On a default deployment, this is /daisy.
5.14.4.3.11 daisy.getDaisyContextPath()
Returns the URL of directory containing the main Daisy sitemap, thus something like file:/..../daisywiki/webapp/daisy/. This can be useful to access Daisy Wiki resources from extensions.
5.14.4.3.12 daisy.getDaisyCocoonPath()
Returns the part of the URL path that is interpreted by Cocoon and leads to the Daisy Wiki sitemap. On a default deployment, this is /daisy. This is useful to call pipelines in the main Daisy Wiki sitemap.
To illustrate the difference with getMountPoint: if the servlet context path would for example be /cocoon, then:
daisy.getMountPoint() would return /cocoon/daisy
and
daisy.getDaisyCocoonPath() would return /daisy
5.14.4.3.13 daisy.getLocale()
Returns the java.util.Locale object for the current user's locale.
5.14.4.3.14 daisy.getLocaleAsString()
Returns the locale as string.
5.14.4.3.15 daisy.getVersionMode()
Returns the active "version mode", which is either 'live' or 'last'. This indicates which version of documents the user wants to see by default.
The returned object is a WikiVersionMode object, converting it to string gives either 'live' or 'last'.
5.14.4.3.16 daisy.getFrontEndContext()
Provides access to front end (= "Daisy Wiki") context.
Since FrontEndContext is specific for a request, it should not be stored in
places that exist longer than the duration of the request (e.g. session, in
stateful flow variables, ...)