Previous page
multi-book Specification
 
The multi-book format is designed for integrating multi-pages (or conventional HTML documents) into one package. Like multi-page, it consists of a set of HTML files and JavaScript programs.
Name of multi-book is the name of its main folder.
Structure

multi-book.html - starting file.

Sub-directories:
  • Content - inclosed multi-pages (or HTML documents).
  • Shell - a program for navigating between multi-pages.

Content

content.js - main list of used documents.
Function Content describes the documents as elements of a JavaScript array in the   mb [index]   format. For example, mb[3] begins definition of a third item in the array. Index -1 is reserved for multi-book's Cover, index 0, - for Contents page (toc).
Usually the array contains just names of multi-page folders. However, full paths for *.html or *.txt files can also be used.
Variable mp_max sets size of the array.

Actual multi-page packages are to be located in the multi-pages folder.
To summarize, you need to put your multi-pages into multi-pages folder, and specify their names in content.js file.

meta.js - META information about the whole multi-book.
It includes definition of Title, Version, Date, Author, and Synopsis. All these variables must be defined (use "" if they are empty or not used).

Files cover.html and toc.html should be a sole responsibility of the content developer.
Folder Content/files is reserved for user's supporting files. For example, you can find there view.css stylesheet, background image, as well as images and sounds directories.


Shell

navigation.js - main engine for the multi-book.
It implements navigation functions: next and previous. Also, there are other supporting methods: init, cover, toc, and help.
Variables Shell and Shell_copyright specify multi-book's version and developer.

The Design forms visual appearance of the multi-book Shell. You may replace this folder with another version, or develop your own design.
Used files:


You can view your Content with different versions of Shell, - just assemble multi-book from required components!

check Download section for ready-to-use examples

Read about multi-page format
Previous page
Up