31 <p> |
31 <p> |
32 This is the API specification for the Helium build toolkit. |
32 This is the API specification for the Helium build toolkit. |
33 </p> |
33 </p> |
34 |
34 |
35 <ul> |
35 <ul> |
|
36 <li><a href="#packages">Packages</a></li> |
36 <li><a href="#projects">Projects</a></li> |
37 <li><a href="#projects">Projects</a></li> |
37 <li><a href="#propertygroups">Property groups</a></li> |
|
38 </ul> |
38 </ul> |
39 |
39 |
40 <h2><a name="projects">Projects</a></h2> |
40 <h2><a name="packages">Packages</a></h2> |
|
41 <p> |
|
42 Helium Ant project files are grouped into packages of related functionality. |
|
43 </p> |
|
44 <table class="docutils"> |
|
45 <tr> |
|
46 <th class="head">Package</th> |
|
47 <th class="head">Projects</th> |
|
48 <th class="head">Description</th> |
|
49 </tr> |
|
50 <#assign packageInfo = {}> |
|
51 <#list doc.antDatabase.package as package> |
|
52 <#assign packageInfo = packageInfo + {package.name: package}> |
|
53 </#list> |
|
54 <#list packageInfo?keys?sort as name> |
|
55 <tr> |
|
56 <td valign="top"><a href="package-${name}.html" target="classframe">${name}</a></td> |
|
57 <td> |
|
58 <#assign projectInfo = {}> |
|
59 <#list packageInfo[name].projectRef as projectRef> |
|
60 <#assign projectInfo = projectInfo + {projectRef.name: doc["antDatabase/project[name='${projectRef.name}']"].summary}> |
|
61 </#list> |
|
62 <#list projectInfo?keys?sort as name> |
|
63 <a href="project-${name}.html" project="classframe">${name}</a><br/> |
|
64 </#list> |
|
65 </td> |
|
66 <td><#recurse packageInfo[name].summary></td> |
|
67 </tr> |
|
68 </#list> |
|
69 </table> |
|
70 <br/> |
|
71 |
|
72 <#--<h2><a name="projects">Projects</a></h2> |
41 <p> |
73 <p> |
42 Helium is configured into a set of Ant project files that group related functionality. |
74 Helium is configured into a set of Ant project files that group related functionality. |
43 </p> |
75 </p> |
44 <table class="docutils"> |
76 <table class="docutils"> |
45 <tr> |
77 <tr> |
46 <th class="head">Project name</th> |
78 <th class="head">Project name</th> |
47 <th class="head">Description</th> |
79 <th class="head">Description</th> |
48 </tr> |
80 </tr> |
49 <#assign projectInfo = {}> |
81 <#assign projectInfo = {}> |
50 <#list doc.antDatabase.project as project> |
82 <#list doc.antDatabase.project as project> |
51 <#assign projectInfo = projectInfo + {project.name: project.documentation}> |
83 <#assign projectInfo = projectInfo + {project.name: project}> |
52 </#list> |
84 </#list> |
53 <#list projectInfo?keys?sort as name> |
85 <#list projectInfo?keys?sort as name> |
54 <tr> |
86 <tr> |
55 <td><a href="project-${name}.html" target="classframe">${name}</a></td> |
87 <td><a href="project-${name}.html" target="classframe">${name}</a></td> |
56 <td><#recurse projectInfo[name]></td> |
88 <td><#recurse projectInfo[name]></td> |
57 </tr> |
89 </tr> |
58 </#list> |
90 </#list> |
59 </table> |
91 </table> |
60 <br/> |
92 <br/>--> |
61 |
|
62 <h2><a name="propertygroups">Property groups</a></h2> |
|
63 <p> |
|
64 Property groups define a set of properties that relate to a specific feature or functionality in Helium. |
|
65 </p> |
|
66 <table class="docutils"> |
|
67 <tr> |
|
68 <th class="head">Property group name</th> |
|
69 <th class="head">Description</th> |
|
70 </tr> |
|
71 <#list data.heliumDataModel.group as group> |
|
72 <tr> |
|
73 <td><a href="propertygroup-${group.name}.html" target="classframe">${group.name}</a></td> |
|
74 <td>${group.description}</td> |
|
75 </tr> |
|
76 </#list> |
|
77 </table> |
|
78 |
93 |
79 <@helium_api_html_footer/> |
94 <@helium_api_html_footer/> |
|
95 |
|
96 |