buildframework/helium/doc/src/index.rst.ftl
author wbernard
Wed, 23 Dec 2009 19:29:07 +0200
changeset 179 d8ac696cc51f
parent 1 be27ed110b50
child 217 0f5e3a7fb6af
permissions -rw-r--r--
helium_7.0-r14027
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/variant
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    83
   tutorials/qt_build
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    84
<#if !ant?keys?seq_contains("sf")>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    85
   nokia/blacktusk/howto-setup-blacktusk-with-helium
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    86
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    87
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    88
.. raw:: html
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
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    91
   <tr valign="top">
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    92
   <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
    93
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    94
.. index::  single: Helium Manual
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    95
  
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    96
Helium Manual
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
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
    99
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
   100
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
   101
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   102
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   103
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   104
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   105
<#if !ant?keys?seq_contains("sf")>   
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   106
   nokia/support
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   107
   nokia/nokia
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   108
   nokia/retrieving
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   109
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   110
   sf
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   111
   manual/running
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   112
   manual/configuring
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   113
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   114
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   115
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   116
   <script type="text/javascript" language="JavaScript"><!--
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   117
   function HideContent(d) {
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   118
   if(d.length < 1) { return; }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   119
   document.getElementById(d).style.display = "none";
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   120
   }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   121
   function ShowContent(d) {
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   122
   if(d.length < 1) { return; }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   123
   document.getElementById(d).style.display = "block";
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   124
   }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   125
   function ReverseContentDisplay(d) {
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   126
   if(d.length < 1) { return; }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   127
   if(document.getElementById(d).style.display == "none") { document.getElementById(d).style.display = "block"; }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   128
   else { document.getElementById(d).style.display = "none"; }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   129
   }
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   130
   //--></script>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   131
   <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('stages')">Stages</a></li></ul>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   132
   <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
   133
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   134
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   135
   :maxdepth: 2
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   136
   
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   137
   manual/stages
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   138
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   139
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   140
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   141
   </div>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   142
<#if !ant?keys?seq_contains("sf")>
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   143
   <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
   144
   <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
   145
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   146
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   147
   :maxdepth: 2
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   148
   
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   149
   nokia/nokiastages
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   150
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   151
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   152
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   153
   </div>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   154
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   155
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   156
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   157
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   158
<#if !ant?keys?seq_contains("sf")>
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   159
   nokia/rndsdk_user_manual
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   160
   nokia/quality
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   161
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   162
   manual/debugging
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   163
   metrics
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   164
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   165
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   166
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   167
   <ul><li class="toctree-l1"><a href="javascript:ReverseContentDisplay('api')">API</a></li></ul>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   168
   <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
   169
   
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   170
* `Helium API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   171
* `Helium Antlib`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   172
* `Ant Tasks`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   173
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   174
.. _`Ant Tasks`: api/ant/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   175
.. _`Helium API`: api/helium/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   176
.. _`Helium Antlib`: helium-antlib/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   177
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   178
<#if !(ant?keys?seq_contains("sf"))>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   179
* `Python API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   180
* `Java API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   181
* `IDO API`_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   182
* `DFS70501 API`_
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   183
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   184
.. _`Python API`: api/python/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   185
.. _`Java API`: api/java/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   186
.. _`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
   187
.. _`DFS70501 API`: dfs70501/api/helium/index.html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   188
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   189
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   190
.. raw:: html
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   191
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   192
   </div>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   193
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   194
<#if !ant?keys?seq_contains("sf")>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   195
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   196
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   197
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   198
   api_changes
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   199
   nokia/releasenotes
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   200
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   201
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   202
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   203
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   204
   </td><td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   205
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   206
Helium Framework configuration
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   207
==============================
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   208
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   209
.. toctree::
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   210
   :maxdepth: 1
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   211
   
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   212
   tutorials/configuration/HowtoCreateANewSignal
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   213
   manual/signaling
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   214
   manual/configuringdiamonds
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   215
   manual/cruisecontrol
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   216
   manual/antlogging
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   217
* helium-antlib_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   218
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   219
.. _helium-antlib: helium-antlib
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   220
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   221
<#if !ant?keys?seq_contains("sf")>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   222
Customer docs
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   223
=============
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   224
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   225
* IDO_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   226
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   227
.. _IDO: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>ido
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   228
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   229
* TeamCI_
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   230
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   231
.. _TeamCI: <#if ant['helium.version']?matches("^\\d+\\.0(?:\\.\\d+)?$")>../</#if>teamci
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   232
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   233
</#if>
d8ac696cc51f helium_7.0-r14027
wbernard
parents: 1
diff changeset
   234
1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   235
Helium Architecture
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   236
===================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   237
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   238
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
   239
coding conventions.
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
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   242
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   243
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   244
 
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   245
   architecture
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   246
  
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   247
.. raw:: html
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   248
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   249
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   250
   <tr valign="top"><td>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   251
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   252
Developer Guide
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   253
==================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   254
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
   255
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
   256
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
   257
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
   258
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   259
.. toctree::
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   260
   :maxdepth: 1
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   261
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   262
<#if !ant?keys?seq_contains("sf")>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   263
   nokia/howto-contribute
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   264
   nokia/legal
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   265
   nokia/testing
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   266
</#if>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   267
   developer_guide
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   268
   coding_conventions
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   269
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   270
.. raw:: html
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
   </td></tr>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   273
   </table>
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   274
   
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   275
Indices and Tables
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   276
==================
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   277
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   278
* :ref:`genindex`
be27ed110b50 Bringing in Helium, imaker and cmaker
Alex Gilkes <alex.gilkes@nokia.com>
parents:
diff changeset
   279
* :ref:`search`