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.
- Load TOC XML
Loads the XML representation of the TOC. - Load TOC levels
Loads the HTML representation of the TOC. Because TOC files can be very large, this API call is designed to be able to grab specific sections of the TOC on demand, while not loading other sections. Theeidparameter allows the API call to grab a specific section of the TOC, while thelevelsparameter allows the depth of the returned HTML to be shortened for performance. The shorter the depth of the returned HTML, the more frequently the client will need to return to the server for more TOC HTML. Therefore, a balance between size of HTML fragments and frequency of requests needs to be struck, based upon the structure, size, and content of the TOC. - Load TOC levels XML
Loads the XML representation of the TOC. Because TOC files can be very large, this API call is designed to be able to grab specific sections of the TOC on demand, while not loading other sections. Theeidparameter allows the API call to grab a specific section of the TOC, while thelevelsparameter allows the depth of the returned XML to be shortened for performance. The shorter the depth of the returned XML, the more frequently the client will need to return to the server for more TOC XML. Therefore, a balance between size of XML fragments and frequency of requests needs to be struck, based upon the structure, size, and content of the TOC. - Load TOC path XML
This API call retrieves the hierarchical path to a document that is within the publication's TOC. Because a TOC is usually loaded in levels for efficiency, it is possible that a document that is down a TOC path that has not been loaded will not be present in the client-side TOC. This API call allows the client to gain information about that document by its ID. The resulting XML has a list of<EID/>elements that list, in document order, the TOC elements that contain the targeted document.