|
|
|
The Model-Driven System Builder
|
|
JeeWiz Architect's Guide
|
|
|
|
Contents
|
|
|
Chapter 17. 'Documentation' Reference
The documentation model describes a document - which in JeeWiz becomes a generated manual.
The key concepts are
- the table of contents ('toc') which holds ...
- a list of indexes, or chapters in the manual, which hold ...
- pages
- subtitles, which are sections or sub-sections beneath indexes and pages.
The out-of-the-box rendering of a documentation model builds a manual in HTML format.
The manual has
- a top-level 'index.html' page, with the table of contents
- a directory per index (chapter) with its own in 'index.html' page, with the chapter contents
- an HTML page for each page object.
Subtitles under each index are included in the index.html page for the index.
Subtitles under a page are included within the page.
Model Information
|
| Name | doc
|
| DescriptiveName | Documentation
|
| Package | uk.co.nte.jw.components.doc
|
17.1 Description Object
17.2 Index Object
17.3 Link Object
17.4 Page Object
17.5 SectionNumberHolder Object
17.6 Subtitle Object
17.7 SubtitleHolder Object
17.8 Toc Object
17.9 TopTip Object
| |
