Documentation Center

home

Initiates display of a publication.

Description

Opens an HTML template pub_home.html; contains starter JavaScript to kick off the pub viewing experience: TOC in the left pane, content in the right pane, menu, footer, etc.

Parameters

action
home
lang
A language version of a publication.
pub
A publication, which is a logical grouping of information (topics and multimedia) related to a specific subject, containing one or more language versions.
skin
The skin name from which to load the UI resource (HTML, CSS, image, JavaScript).

Example URL

http://<host>:<port>/<context>/web/pub.xql?action=home&lang=<value>&pub=<value>&skin=<value>

Successful Result

Beginning publication display (HTML).

Failed Result

Accessing this API feature requires the "Manage pubs" permission, and the function will return a 401 Unauthorized (html/401unauthorized.html) page if the permission is not available.