JeeWiz Architect's Guide


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 17. 'Documentation' Reference

17.8 Toc Object

Description The Table of Contents is stored in file index.html at the root of the documentation tree. It contains one or more index objects each of which will appear as an HTML link from the ToC.

Each index may include CDATA text which will appear as body text beneath the link and should describe the information that is obtainable via that ToC link.

The ToC creates

a directory
with an index.html file holding the table of contents and descriptions.
The ToC directory will contain directories for each of the index objects

Contained
Lists

1

Name   index

Type   index

GenerateAllList   false

Inherited
properties

name (base property)

description (base property)

template (base property)

text (base property)

jwpattern (base property)

17.8.1	Property 'title'
17.8.2	Property 'doChaptersInToc'

17.8.1 Property 'title'

*Description*	The title of the documentation. All page titles in the documentation tree will include this name as the first component of their titles.
*Type*	String
*Required*	true

17.8.2 Property 'doChaptersInToc'

*Description*	Most manuals are long enough that a separate 'Chapters' section in the Table Of Concepts is worthwhile. So by default, the 'Chapters' section is generated. However, for very short manuals (e.g. containing just one chapter), this may be unnecessary and look odd. In this case, specify 'false' for the do-chapters-in-toc property.
*Type*	boolean
*Default*	false