JeeWiz Home  
The Model-Driven System Builder

JeeWiz Architect's Guide
 
Contents  >   17.  'Documentation' Reference
 


17.2 Index Object

Used on
toc
SuperclasssubtitleHolder
DescriptionSpecification of an index documentation page.

The index is a constituent of the ToC. It produces
  • a directory using the 'subdir' property of the index
  • and index.html that
The page consists of a title plus one or more subordinate pages. Optionally, CDATA text can be included which will be used as intro/summary text and presented above the contents list.
Contained
Lists
1
Name  subtitle
Type  subtitle
GenerateAllList  false
 
2
Name  page
Type  page
GenerateAllList  false
Inherited
properties
name (base property)

description (base property)

template (base property)

text (base property)

jwpattern (base property)

sectionNumber from sectionNumberHolder.sectionNumber

title from sectionNumberHolder.title

omitFromToc from sectionNumberHolder.omitFromToc

aggregateChildList from sectionNumberHolder.aggregateChildList

aggregateChildContentsList from sectionNumberHolder.aggregateChildContentsList

indentLevel from sectionNumberHolder.indentLevel

nextSectionOverall from sectionNumberHolder.nextSectionOverall

previousSectionOverall from sectionNumberHolder.previousSectionOverall


17.2.1  Property 'subdir'
Description The directory within document root in which the index page and its sub-pages are held.
TypeString
Requiredtrue
 


Copyright (c) 2001-2008 New Technology/enterprise Ltd.