buildframework/helium/doc/src/index.rst.ftl
author timothy.murphy@nokia.com
Mon, 10 May 2010 16:46:16 +0100
branchfix
changeset 542 80c21f026f0a
parent 217 0f5e3a7fb6af
permissions -rw-r--r--
fix: switch rfi file creation back on
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
.. Helium Documentation documentation master file, created by sphinx-quickstart on Fri May 09 09:49:44 2008.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    23
   You can adapt this file completely to your liking, but it should at least
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    24
   contain the root `toctree` directive.
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
.. index::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    27
  module:  Helium Documentation
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    28
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    29
====================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    30
Helium documentation
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    31
====================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    32
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    33
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    34
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    35
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    36
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    37
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    38
   <table border="0" cellspacing="0" cellpadding="10">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    39
   <tr valign="top">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    40
   <td width="50%" style="border-right: 1px solid black">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    41
 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    42
.. index::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    43
  single: Getting Started
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    44
   
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    45
Getting Started
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    46
================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    47
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    48
This section contains instructions on how to get started with Helium including where to get it from and how to use it at the very simplest level. 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    49
<#if !(ant?keys?seq_contains("sf"))>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    50
This section also has a link to an elearning that goes through Helium at a very high level.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    51
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    52
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    53
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    54
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    55
   
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    56
   introduction
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    57
   quick_start_guide
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    58
   feature_list
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    59
   user-graph
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    60
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    61
<#if !(ant?keys?seq_contains("sf"))>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    62
* Elearning_
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    63
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    64
.. _Elearning: http://lmp.nokia.com/lms/lang-en/taxonomy/TAX_Search.asp?UserMode=0&SearchStr=helium
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    65
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    66
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    67
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    68
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    69
   </td><td width="50%">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    70
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    71
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    72
Tutorials and HOWTOs
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    73
=====================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    74
This section lists all the available tutorials on Helium and how to configure and use it.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    75
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    76
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    77
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    78
   
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    79
   tutorials/configuration/SimplestConfiguration
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    80
   tutorials/configuration/UseHlmTasksInConfiguration
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    81
   tutorials/rom_image
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    82
   tutorials/qt_build
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    83
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    84
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    85
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    86
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    87
   <tr valign="top">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    88
   <td width="50%" style="border-right: 1px solid black" rowspan="2">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    89
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    90
.. index::  single: Helium Manual
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    91
  
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    92
Helium Manual
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    93
==============
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    94
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    95
This section contains the details of the various activities that can be performed by Helium, you should look
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    96
here for specific information about a task or action.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    97
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    98
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    99
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   100
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   101
<#if !ant?keys?seq_contains("sf")>   
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   102
   nokia/support
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   103
   nokia/nokia
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   104
   nokia/retrieving
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   105
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   106
   sf
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   107
   manual/running
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   108
   manual/configuring
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   109
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   110
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   111
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   112
   <script type="text/javascript" language="JavaScript"><!--
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   113
    function ReverseContentDisplay(d) {
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   114
        if(d.length < 1) { return; }
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   115
    
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   116
         var elem = document.getElementsByTagName('div');
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   117
         for(var i = 0; i < elem.length; i++)
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   118
         {
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   119
             if(elem[i].style.display == "block" && elem[i] != document.getElementById(d)) {
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   120
                 elem[i].style.display = "none";
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   121
             }
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   122
         }
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   123
    
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   124
        if(document.getElementById(d).style.display == "none") { document.getElementById(d).style.display = "block"; }
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   125
        else { document.getElementById(d).style.display = "none"; }
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   126
   }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   127
   //--></script>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   128
   <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('stages')">Stages</a></li></ul>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   129
   <div id="stages" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;">
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   130
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   131
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   132
   :maxdepth: 2
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   133
   
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   134
   manual/stages
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   135
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   136
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   137
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   138
   </div>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   139
<#if !ant?keys?seq_contains("sf")>
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   140
   <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('nokiastages')">Nokia Stages</a></li></ul>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   141
   <div id="nokiastages" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;">
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   142
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   143
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   144
   :maxdepth: 2
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   145
   
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   146
   nokia/nokiastages
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   147
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   148
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   149
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   150
   </div>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   151
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   152
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   153
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   154
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   155
<#if !ant?keys?seq_contains("sf")>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   156
   nokia/quality
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   157
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   158
   manual/debugging
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   159
   metrics
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   160
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   161
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   162
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   163
   <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('api')">API</a></li></ul>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   164
   <div id="api" style="display:none; position:absolute; border-style: solid; background-color: white; padding: 5px;">
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   165
   
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   166
* `Helium API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   167
* `Helium Antlib`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   168
* `Ant Tasks`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   169
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   170
.. _`Ant Tasks`: api/ant/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   171
.. _`Helium API`: api/helium/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   172
.. _`Helium Antlib`: helium-antlib/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   173
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   174
<#if !(ant?keys?seq_contains("sf"))>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   175
* `Python API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   176
* `Java API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   177
* `IDO API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   178
* `DFS70501 API`_
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   179
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   180
.. _`Python API`: api/python/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   181
.. _`Java API`: api/java/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   182
.. _`IDO API`: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>ido/api/helium/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   183
.. _`DFS70501 API`: dfs70501/api/helium/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   184
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   185
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   186
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   187
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   188
   </div>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   189
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   190
<#if !ant?keys?seq_contains("sf")>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   191
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   192
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   193
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   194
   api_changes
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   195
   nokia/releasenotes
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   196
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   197
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   198
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   199
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   200
   </td><td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   201
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   202
Helium Framework configuration
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   203
==============================
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   204
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   205
.. toctree::
217
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   206
   :maxdepth: 3
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   207
   
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   208
   helium-antlib/index
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   209
   
0f5e3a7fb6af helium_8.0-r15308
wbernard
parents: 179
diff changeset
   210
.. toctree::
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   211
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   212
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   213
   manual/cruisecontrol
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   214
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   215
<#if !ant?keys?seq_contains("sf")>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   216
Customer docs
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   217
=============
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   218
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   219
* IDO_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   220
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   221
.. _IDO: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>ido
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   222
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   223
* TeamCI_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   224
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   225
.. _TeamCI: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>teamci
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   226
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   227
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   228
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   229
Helium Architecture
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   230
===================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   231
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   232
This section describes the architecture of Helium. It also contains a link to the style guide to be used for 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   233
coding conventions.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   234
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   235
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   236
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   237
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   238
 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   239
   architecture
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   240
  
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   241
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   242
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   243
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   244
   <tr valign="top"><td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   245
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   246
Developer Guide
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   247
==================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   248
This section contains information on how to make changes to Helium either as a tools team developer or an external 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   249
developer. The 'developer guide' link contains information on the structure of the directories and some important
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   250
information on how to add libraries and other miscellaneous information.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   251
It also contains details on how to test the changes made.
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   252
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   253
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   254
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   255
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   256
<#if !ant?keys?seq_contains("sf")>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   257
   nokia/howto-contribute
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   258
   nokia/legal
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   259
   nokia/testing
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   260
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   261
   developer_guide
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   262
   coding_conventions
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   263
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   264
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   265
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   266
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   267
   </table>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   268
   
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   269
Indices and Tables
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   270
==================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   271
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   272
* :ref:`genindex`
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   273
* :ref:`search`