[ROOT] / doc / toc / AgoBrowse / Class / CompileController / Compile / __TOCDet

ClassMemberAttribute

Compiles a hierarchical 'picture book' from the given parameter.

The result is a complete standalone HTML page (except for the actual images) without any external references to Javascript or CSS.

Press spacebar on the resulting HTML page for instructions about how to browse the 'picture book'.

The property stream format for a picture book is as follows:

Example 1) Book without any chapters, only one level of pages.
(in the compiled HTML page Arrow Left and Right are used for browsing):
(the ... indicates the initial position in the data storage, like [userId]/[nameOfBook], for instance 'bef/MyPictureBook').
.../URL = https://somewhere.com/titlePage.jpg
.../FirstPicture/URL = https://somewhere.com/firstPicture.jpg
.../SecondPicture/URL = https://somewhere.com/secondPicture.jpg
and so on.

Example 2) Book with subchapters.
(in the compiled HTML page Arrow Up and Down are used for moving between levels):
(the ... indicates the initial position in the data storage, like [userId]/[nameOfBook], for instance 'bef/MyAirplaneBook').
.../URL = https://somewhere.com/titlePage.jpg
.../FirstChapter/URL = https://somewhere.com/firstChapterTitlePage.jpg
.../FirstChapter/FirstPicture/URL = https://somewhere.com/firstChapterFirstPicture.jpg
.../FirstChapter/SecondPicture/URL = https://somewhere.com/firstChapterSecondPicture.jpg
.../SecondChapter/URL = https://somewhere.com/secondChapterTitlePage.jpg
.../SecondChapter/FirstSubChapter/URL = https://somewhere.com/secondChapterFirstSubChapterTitlePage.jpg
.../SecondChapter/FirstSubChapter/FirstPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg
.../SecondChapter/FirstSubChapter/SecondPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg

NOTE: The book will be compiled with keys in alphabetical order.

In addition to the key 'URL' the following other keys are recognized: 'Title' and 'License'.
'License' should either be an URL pointing to information about the picture and its distribution license, or a text specifying the license.

HINT: You can use a numbering system in order to keep desired order like:
HINT: 001_Tigers/URL = https://somewhere.com/Tigers.jpg
HINT: 001_Tigers/001_SleepingTiger/URL = https://somewhere.com/SleepingTiger.jpg
HINT: 001_Tigers/002_EatingTiger/URL = https://somewhere.com/EatingTiger.jpg
HINT: 002_Lions/URL = https://somewhere.com/Lions.jpg
HINT: 002_Lions/001_SleepingLion/URL = https://somewhere.com/SleepingLion.jpg
HINT: (this ensures that tigers come before lions, and that sleeping comes before eating.)

NOTE: In case API requests are to be done through HTTPS is is recommended to use only HTTPS picture URLs,
NOTE: due to modern browsers not accepting HTTP content within a HTTPS web page.
NOTE: This is not a problem for a locally stored HTML page however.
NOTE: (when the compiled HTML page is stored within the local file system in your computer).

Edit

Generated 2025-06-18 23:27:05.500 UTC