buildframework/helium/doc/antdoclet/html/main.vm
changeset 587 85df38eb4012
equal deleted inserted replaced
217:0f5e3a7fb6af 587:85df38eb4012
       
     1 ##
       
     2 ## This template is the entry point for calling other templates.
       
     3 ## The output of this template goes to stdout.
       
     4 ##
       
     5 ## Objects available in context:
       
     6 ##
       
     7 ## $velocity   - Helper object for processing other templates (of type VelocityFacade)
       
     8 ## $antroot   - Contains all the Ant tasks/types (of type AntRoot)
       
     9 ## $title         - Project title (of type String)
       
    10 ##
       
    11 
       
    12 AntDoclet - Running project $title
       
    13 
       
    14 - Generating Task and Types documentation...
       
    15 ##
       
    16 #foreach( $taskDoc in $antroot.getAll() ) ##
       
    17   #if ( ! $taskDoc.isIgnored() )
       
    18 
       
    19 - Processing $taskDoc.antName ##
       
    20       $velocity.eval( "task.vm", "${taskDoc.getFullClassName()}.html" ) ##
       
    21   #else ##
       
    22 - Ignoring $taskDoc.fullClassName()##
       
    23   #end ##
       
    24 #end ##
       
    25 
       
    26 
       
    27 - Generating Navigation indexes...
       
    28 ## Now, generate an "index" file for the categories, and one for each category
       
    29 $velocity.eval( "libindex.vm", "libindex.html" )
       
    30 $velocity.eval( "overview.vm", "overview.html" )
       
    31 #foreach( $category in $antroot.getCategories() )
       
    32 	$velocity.eval( "taskindex.vm", "index.${category}.html" )
       
    33 #end
       
    34 #set($category = "all")
       
    35 $velocity.eval( "taskindex.vm", "index.${category}.html" )
       
    36 
       
    37 - Done