/ doc / toc / AgoBrowse / Class / CompileController / Compile

Compile

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = AgoBrowse
__TOCDet/Description = Compiles a hierarchical 'picture book' from the given parameter.0x000D0x000A0x000D0x000AThe result is a complete standalone HTML page (except for the actual images) without any external references to Javascript or CSS.0x000D0x000A0x000D0x000APress spacebar on the resulting HTML page for instructions about how to browse the 'picture book'.0x000D0x000A0x000D0x000AThe property stream format for a picture book is as follows:0x000D0x000A0x000D0x000AExample 1) Book without any chapters, only one level of pages.0x000D0x000A(in the compiled HTML page Arrow Left and Right are used for browsing):0x000D0x000A(the ... indicates the initial position in the data storage, like 0x005BuserId0x005D/0x005BnameOfBook0x005D, for instance 'bef/MyPictureBook').0x000D0x000A.../URL = https://somewhere.com/titlePage.jpg 0x000D0x000A.../FirstPicture/URL = https://somewhere.com/firstPicture.jpg 0x000D0x000A.../SecondPicture/URL = https://somewhere.com/secondPicture.jpg 0x000D0x000Aand so on.0x000D0x000A0x000D0x000AExample 2) Book with subchapters.0x000D0x000A(in the compiled HTML page Arrow Up and Down are used for moving between levels):0x000D0x000A(the ... indicates the initial position in the data storage, like 0x005BuserId0x005D/0x005BnameOfBook0x005D, for instance 'bef/MyAirplaneBook').0x000D0x000A.../URL = https://somewhere.com/titlePage.jpg 0x000D0x000A.../FirstChapter/URL = https://somewhere.com/firstChapterTitlePage.jpg 0x000D0x000A.../FirstChapter/FirstPicture/URL = https://somewhere.com/firstChapterFirstPicture.jpg 0x000D0x000A.../FirstChapter/SecondPicture/URL = https://somewhere.com/firstChapterSecondPicture.jpg 0x000D0x000A.../SecondChapter/URL = https://somewhere.com/secondChapterTitlePage.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/URL = https://somewhere.com/secondChapterFirstSubChapterTitlePage.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/FirstPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/SecondPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg 0x000D0x000A0x000D0x000ANOTE: The book will be compiled with keys in alphabetical order.0x000D0x000A0x000D0x000AIn addition to the key 'URL' the following other keys are recognized: 'Title' and 'License'.0x000D0x000A'License' should either be an URL pointing to information about the picture and its distribution license, or a text specifying the license.0x000D0x000A0x000D0x000AHINT: You can use a numbering system in order to keep desired order like:0x000D0x000AHINT: 001_Tigers/URL = https://somewhere.com/Tigers.jpg 0x000D0x000AHINT: 001_Tigers/001_SleepingTiger/URL = https://somewhere.com/SleepingTiger.jpg 0x000D0x000AHINT: 001_Tigers/002_EatingTiger/URL = https://somewhere.com/EatingTiger.jpg 0x000D0x000AHINT: 002_Lions/URL = https://somewhere.com/Lions.jpg 0x000D0x000AHINT: 002_Lions/001_SleepingLion/URL = https://somewhere.com/SleepingLion.jpg 0x000D0x000AHINT: (this ensures that tigers come before lions, and that sleeping comes before eating.)0x000D0x000A0x000D0x000ANOTE: In case API requests are to be done through HTTPS is is recommended to use only HTTPS picture URLs,0x000D0x000ANOTE: due to modern browsers not accepting HTTP content within a HTTPS web page.0x000D0x000ANOTE: This is not a problem for a locally stored HTML page however.0x000D0x000ANOTE: (when the compiled HTML page is stored within the local file system in your computer).0x000D0x000A
__TOCDet/DocFragType = ClassMember
__TOCDet/IsInherited = False
__TOCDet/IsInheritedDoc = False
__TOCDet/Lines = 46
__TOCDet/Name = Compile
__TOCDet/Namespace = AgoBrowse.Controllers
__TOCDet/ParentNamespace = AgoBrowse
__TOCDet/Type = CompileController
__TOCDet/Attribute/DeclaringType = CompileController
__TOCDet/Attribute/Description = Compiles a hierarchical 'picture book' from the given parameter.0x000D0x000A0x000D0x000AThe result is a complete standalone HTML page (except for the actual images) without any external references to Javascript or CSS.0x000D0x000A0x000D0x000APress spacebar on the resulting HTML page for instructions about how to browse the 'picture book'.0x000D0x000A0x000D0x000AThe property stream format for a picture book is as follows:0x000D0x000A0x000D0x000AExample 1) Book without any chapters, only one level of pages.0x000D0x000A(in the compiled HTML page Arrow Left and Right are used for browsing):0x000D0x000A(the ... indicates the initial position in the data storage, like 0x005BuserId0x005D/0x005BnameOfBook0x005D, for instance 'bef/MyPictureBook').0x000D0x000A.../URL = https://somewhere.com/titlePage.jpg 0x000D0x000A.../FirstPicture/URL = https://somewhere.com/firstPicture.jpg 0x000D0x000A.../SecondPicture/URL = https://somewhere.com/secondPicture.jpg 0x000D0x000Aand so on.0x000D0x000A0x000D0x000AExample 2) Book with subchapters.0x000D0x000A(in the compiled HTML page Arrow Up and Down are used for moving between levels):0x000D0x000A(the ... indicates the initial position in the data storage, like 0x005BuserId0x005D/0x005BnameOfBook0x005D, for instance 'bef/MyAirplaneBook').0x000D0x000A.../URL = https://somewhere.com/titlePage.jpg 0x000D0x000A.../FirstChapter/URL = https://somewhere.com/firstChapterTitlePage.jpg 0x000D0x000A.../FirstChapter/FirstPicture/URL = https://somewhere.com/firstChapterFirstPicture.jpg 0x000D0x000A.../FirstChapter/SecondPicture/URL = https://somewhere.com/firstChapterSecondPicture.jpg 0x000D0x000A.../SecondChapter/URL = https://somewhere.com/secondChapterTitlePage.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/URL = https://somewhere.com/secondChapterFirstSubChapterTitlePage.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/FirstPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg 0x000D0x000A.../SecondChapter/FirstSubChapter/SecondPicture/URL = https://somewhere.com/secondChapterFirstSubChapterFirstPicture.jpg 0x000D0x000A0x000D0x000ANOTE: The book will be compiled with keys in alphabetical order.0x000D0x000A0x000D0x000AIn addition to the key 'URL' the following other keys are recognized: 'Title' and 'License'.0x000D0x000A'License' should either be an URL pointing to information about the picture and its distribution license, or a text specifying the license.0x000D0x000A0x000D0x000AHINT: You can use a numbering system in order to keep desired order like:0x000D0x000AHINT: 001_Tigers/URL = https://somewhere.com/Tigers.jpg 0x000D0x000AHINT: 001_Tigers/001_SleepingTiger/URL = https://somewhere.com/SleepingTiger.jpg 0x000D0x000AHINT: 001_Tigers/002_EatingTiger/URL = https://somewhere.com/EatingTiger.jpg 0x000D0x000AHINT: 002_Lions/URL = https://somewhere.com/Lions.jpg 0x000D0x000AHINT: 002_Lions/001_SleepingLion/URL = https://somewhere.com/SleepingLion.jpg 0x000D0x000AHINT: (this ensures that tigers come before lions, and that sleeping comes before eating.)0x000D0x000A0x000D0x000ANOTE: In case API requests are to be done through HTTPS is is recommended to use only HTTPS picture URLs,0x000D0x000ANOTE: due to modern browsers not accepting HTTP content within a HTTPS web page.0x000D0x000ANOTE: This is not a problem for a locally stored HTML page however.0x000D0x000ANOTE: (when the compiled HTML page is stored within the local file system in your computer).0x000D0x000A
__TOCDet/Attribute/MethodName = Compile
__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult Compile(ARCCore.IP, System.String)

Edit single sub keys only: __TOCDet

Generated 2025-06-18 13:40:55.056 UTC