buildframework/helium/doc/src/api/overview-summary.html.ftl
author wbernard
Thu, 04 Mar 2010 15:10:37 +0200
changeset 217 0f5e3a7fb6af
parent 1 be27ed110b50
permissions -rw-r--r--
helium_8.0-r15308
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     1
<#--
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     2
============================================================================ 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     3
Name        : 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     4
Part of     : Helium 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     5
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     6
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     7
All rights reserved.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     8
This component and the accompanying materials are made available
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
     9
under the terms of the License "Eclipse Public License v1.0"
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    10
which accompanies this distribution, and is available
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    11
at the URL "http://www.eclipse.org/legal/epl-v10.html".
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    12
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    13
Initial Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    14
Nokia Corporation - initial contribution.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    15
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    16
Contributors:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    17
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    18
Description:
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    19
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    20
============================================================================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    21
-->
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    22
<#include "api.ftllib"/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    23
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    24
<@helium_api_header title="Helium API"/>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    25
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    26
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    27
    <center>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    28
        <h1>Helium API</h1>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    29
    </center>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    30
    
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    31
    <p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    32
    This is the API specification for the Helium build toolkit.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    33
    </p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    34
    
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    35
    <ul>
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    36
        <li><a href="#packages">Packages</a></li>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    37
        <li><a href="#projects">Projects</a></li>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    38
    </ul>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    39
    
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    40
    <h2><a name="packages">Packages</a></h2>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    41
    <p>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    42
    Helium Ant project files are grouped into packages of related functionality.
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    43
    </p>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    44
    <table class="docutils">
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    45
        <tr>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    46
            <th class="head">Package</th>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    47
            <th class="head">Projects</th>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    48
            <th class="head">Description</th>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    49
        </tr>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    50
        <#assign packageInfo = {}>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    51
        <#list doc.antDatabase.package as package>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    52
            <#assign packageInfo = packageInfo + {package.name: package}>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    53
        </#list>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    54
        <#list packageInfo?keys?sort as name>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    55
            <tr>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    56
                <td valign="top"><a href="package-${name}.html" target="classframe">${name}</a></td>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    57
                <td>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    58
                    <#assign projectInfo = {}>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    59
                    <#list packageInfo[name].projectRef as projectRef>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    60
                        <#assign projectInfo = projectInfo + {projectRef.name: doc["antDatabase/project[name='${projectRef.name}']"].summary}>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    61
                    </#list>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    62
                    <#list projectInfo?keys?sort as name>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    63
                        <a href="project-${name}.html" project="classframe">${name}</a><br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    64
                    </#list>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    65
                </td>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    66
                <td><#recurse packageInfo[name].summary></td>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    67
            </tr>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    68
        </#list>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    69
    </table>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    70
    <br/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    71
    
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    72
    <#--<h2><a name="projects">Projects</a></h2>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    73
    <p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    74
    Helium is configured into a set of Ant project files that group related functionality.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    75
    </p>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    76
    <table class="docutils">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    77
        <tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    78
            <th class="head">Project name</th>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    79
            <th class="head">Description</th>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    80
        </tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    81
        <#assign projectInfo = {}>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    82
        <#list doc.antDatabase.project as project>
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    83
            <#assign projectInfo = projectInfo + {project.name: project}>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    84
        </#list>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    85
        <#list projectInfo?keys?sort as name>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    86
            <tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    87
                <td><a href="project-${name}.html" target="classframe">${name}</a></td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    88
                <td><#recurse projectInfo[name]></td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    89
            </tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    90
        </#list>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    91
    </table>
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    92
    <br/>-->
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    93
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    94
<@helium_api_html_footer/>
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    95
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 1
diff changeset
    96