Table of contents
This document is a technical description of how the zip file is built. The zip file contains all elements in the book and are rendered as html files. You must have basic knowledge in html and xml for implementation usage.
It's also possible to just open the index.html file to do a basic navigation through the content.
Contents of the zip file
The zip file contains all articles, folders, documents and links in your handbook.
Ex: Content of the zip file
Articles/folders are rendered as html files and placed in the «Pages» folder. Structure of the book is converted to an xml document. The index.html contains all elements in the root level of the handbook. All documents used in the book are placed in the folder «Resources»
This file contains all information about the structure of the book. An example of the file is copied in figure 1. All <element> tag inside <contents> are contents of the book. Each <element> could be a file, link, article or folder. Figure 2 describes information of attributes inside <element>. An element with type="Folder" can contain several <element>.
|Name||Name of the element|
The available types are:
Article, Folder, Url, Resource (Documents)
|Value||Pointer to name of rendered html file in Pages folder, or resource in resource folder if type is resource|
|IsVisible||Bool: 0 or 1 if the element is visible for end users in the handbook|
|ItemId||Unique Id for all elements. Can be used for integration logic.|
|ContextId||Context id of the element. Corresponds to the id in end user. Also name of rendered html file|
|CultureCode||Language code of the element|
This file is the root level of the book. Open it in web browser to navigate. It contains links to all elements that belong to the root level, inside <div id="content">.
Pages folder contains all rendered html files. It could be a catalog, an article or a link.
Each rendered html file has the following information
- Link to your book.
- Type of the element
- Last modified date
- If an article has a link to an article B, and article B is found in the book. You will see the link as marked with yellow background in figure 4. If the article B is not found in the book, it will link with a hashtag, see red background in figure 4.
The most important information is inside the <div id="content">. Figure 5 describe information about the attributes inside content div element. If current element is a folder, it should contain a list of links to underlying elements, more detail in figure 6
[Article]: if element is an article
[collectiveagreement]: if element is a collective agreement
Officially modified date of active version
Unique ID of the rendered page, same as contextid in table 2
[nb-NO]: language code of the element, norwegian
Unique ID for each element
: if the element is not visible for end user
|Data-lastwritedate||Last modified date.|
|Data-isedited||: if the element has not been modified after publishing|
: if the element has been modified after publishing
|Data-guid||the unique guide for the element. Only available if the element has contenttype collectiveagreement|
The resource folder contains all documents/attachments which are in used in the book.
If you do have collective agreements in your handbook, this will also be exported as from version 6.11.10.
You will get an extra folder called CollectiveAgreements, and a file called resource.xml
The element node (the article) has a list of resources. Each resource is in this case a specific agreement. The attributes for the resource is documented in figure 7.
|Agreement||Name of main agreement|
|Name||Name of the resource|
The available types are: CollectiveAgreement
|Value||Pointer to name of rendered html file in CollectiveAgreements folder|
|Guid||The unique GUID for the resource|
Figure 5 describes information about the attributes inside content div element.