Extending LiveContent S1000D
LiveContent S1000D can be extended using Application Program Interfaces. This section provides a complete API reference for SDL LiveContent S1000D.
- Annotation operations
Annotations cover bookmarks and notes, which can be attached to a document, or to within an element within a document. These API functions cover creating, editing, deleting and viewing annotations. - Application and publication config operations
The application and publication config API grants read access to any data that is registered in the configuration files for LiveContent. - Audit trail operations
The audit trail is an XML record of a user's sessions, and can record events at any level of granularity. These API functions allow for the opening, closing, viewing and deleting of audit trails, as well as providing a generic save event function that is used to record any type of user activity. - Authentication operations
Authentication operations allow a user to log in to LiveContent and gain a valid session ID. Unless anonymous access is enabled, a user must log into LiveContent to be able to access the majority of the resources and data. Whenever accessing the API calls for a specific publication, the user must request and gain a session ID that is valid specifically for that publication. - Client counting operations
When deployed on a user's desktop, LiveContent tracks the number of client connections that are currently active. If configured, LiveContent will automatically shut down when the connection count reaches zero. - Document and XML operations
The main content node within LiveContent is a document-a single piece of XML content that can be accessed and formatted in multiple ways. These document and XML API functions give access to the different formatted versions of a document, and grant access to its internal XML structure and metadata. - Filtering and state table operations
LiveContent is capable of storing information in XML state tables. This information is primarily used for runtime storage of content, dynamic troubleshooting variables, and to store filtering conditions. This information can be stored and retrieved on a session basis or by user, which will persist between sessions. - Generic form operations
Generic forms allow LiveContent to capture any type of user input through an XHTML form. This information can be saved, edited, deleted, and printed to PDF using these API functions. Generic forms can be used for a wide variety of purposes, from gathering direct user feedback to saving user search queries. - Help Operations
The help operations retrieve URLs that can be loaded to gain access to the help resources and XHTML documents. The location and name of these help resources are set in the application configuration, allowing each IETM to change its help resources as needed without needing to change the client-side API calls. - Incremental update operations
LiveContent supports incremental updates, allowing the application to integrate of a subset of an entire publication that has changed. Only the changed files need be distributed to the application, and LiveContent rebuilds the XML database, reports, and search indexes with the updated content. These functions enable the client to prepare, complete, and rollback incremental updates. The same set of functionality is available for local, manual updates as well as automatic updates downloaded over the internet. A user can use an XHTML interface to choose an update zip from his or her local drive and install it, or can connect to a LiveContent Update Server and download updates from that server. - Keystone page operations
Keystone pages are the main pages that a user navigates between when using LiveContent. Once a user has opened the main page to view a publication, the majority of content is fetched and displayed using AJAX, and the original page is never reloaded. - Language operations
Language operations provide an API call to load the LiveContent S1000D user interface in a specific language. - Large table operations
Large table operations provide tools for working with large tables in LiveContent S1000D, including API calls for identifying table sections, navigating between sections, searching for table contents, and printing table sections. - Linking operations
The linking operations help to resolve references that span documents. - Media operations
Media operations provide tools for working with various types of media. - Printing operations
The main content node within LiveContent is a document-a single piece of XML content that can be accessed and formatted in multiple ways. The printing API functions can render this XML content or graphics as a PDF document. - Report and revision highlights operations
When a publication is published with LiveContent, the publishing engine creates reports on a number of subjects. These API functions grant access to the invalid references, missing images, and a revision highlights report that the publishing engine has prepared. - Resource loading operations
The resource loading operations give access to all the different types of resources that LiveContent can provide. Based on the configuration of the IETM, different resources may be served up for each publication, or collection through the same resource call. For example, requesting a menu resource may retrieve specialized menu file for one publication, and a different menu file for a second publication, though the request URL is the same. - Search operations
Searching is a powerful doorway into the content stored within LiveContent. The search API functions allow for powerful queries to be passed into the XML database to quickly locate content. They also grant access to wordwheels, pre-generated lists of possible keywords that the user can employ to quickly refine search queries - Table of Contents operations
The TOC is the main navigation component within LiveContent, allowing a user to browse and open documents. The TOC API functions give access to the TOC and its structure. - User management operations
User management operations provide tools for working with users and user groups in LiveContent S1000D. - User preferences operations
A user can set certain preferences that define some of the operation of LiveContent. These preferences are stored in the user's profile and persist between LiveContent sessions. - XML Proxy operations
The XML Proxy API functions provide a way for LiveContent S1000D to easily access HTTP services. This provides a quick and easy way to communicate to other services and systems that employ this standard protocol.