buildframework/helium/doc/antdoclet/html/main.vm
author Jon Chatten
Thu, 26 Aug 2010 13:41:01 +0100
changeset 630 31ef8a13d4f4
parent 587 85df38eb4012
permissions -rw-r--r--
sbs version 2.15.1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
## This template is the entry point for calling other templates.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
## The output of this template goes to stdout.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
## Objects available in context:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
## $velocity   - Helper object for processing other templates (of type VelocityFacade)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
## $antroot   - Contains all the Ant tasks/types (of type AntRoot)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
## $title         - Project title (of type String)
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
AntDoclet - Running project $title
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
- Generating Task and Types documentation...
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
#foreach( $taskDoc in $antroot.getAll() ) ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
  #if ( ! $taskDoc.isIgnored() )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
- Processing $taskDoc.antName ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
      $velocity.eval( "task.vm", "${taskDoc.getFullClassName()}.html" ) ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
  #else ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
- Ignoring $taskDoc.fullClassName()##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
  #end ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
#end ##
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
- Generating Navigation indexes...
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
## Now, generate an "index" file for the categories, and one for each category
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
$velocity.eval( "libindex.vm", "libindex.html" )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
$velocity.eval( "overview.vm", "overview.html" )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
#foreach( $category in $antroot.getCategories() )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
	$velocity.eval( "taskindex.vm", "index.${category}.html" )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
#end
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
#set($category = "all")
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
$velocity.eval( "taskindex.vm", "index.${category}.html" )
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
- Done