Dokument


The Anatomy of a Dokument

Each user guide in Dokument is called a Book and they contain the following files:

Config File

Each book had a config file that contains the user guide properties like name, version & author. This file also containes the navigation array defining the structure of the table of contents and all pages in the book.

This file is stored in: ./application/dokument/{book_name}/config.php

View Files

View files contain the main content HTML of the page. They are named corresponing to the page key in the navigation array.

These file are stored in: ./application/views/{book_name}/

The Archive

The Book archive contains all exported version of your user guide. They are named in accordance with the version number e.g. {book_name}_{version}.

Each time a book is built both a user_guide directory and user_guide archive will be created in this folder.

These file are stored in: ./application/dokument/{book_name}/archive

The archive folder will not appear until you have build your user guide.