buildframework/helium/doc/src/api/api.ftllib
changeset 1 be27ed110b50
child 217 0f5e3a7fb6af
equal deleted inserted replaced
0:044383f39525 1:be27ed110b50
       
     1 <#--
       
     2 ============================================================================ 
       
     3 Name        : 
       
     4 Part of     : Helium 
       
     5 
       
     6 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     7 All rights reserved.
       
     8 This component and the accompanying materials are made available
       
     9 under the terms of the License "Eclipse Public License v1.0"
       
    10 which accompanies this distribution, and is available
       
    11 at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
    12 
       
    13 Initial Contributors:
       
    14 Nokia Corporation - initial contribution.
       
    15 
       
    16 Contributors:
       
    17 
       
    18 Description:
       
    19 
       
    20 ============================================================================
       
    21 -->
       
    22 
       
    23 <#if ant?keys?seq_contains("tracurl")>
       
    24     <#assign helium_browser_trunk=ant.tracurl>
       
    25 <#else>
       
    26     <#assign helium_browser_trunk="">
       
    27 </#if>
       
    28 
       
    29 <#macro helium_api_navbar>
       
    30 <!-- ========= start of top navbar ======= -->
       
    31 <a name="navbar_top"><!-- --></a>
       
    32 <a href="#skip-navbar_top" title="skip navigation links"></a>
       
    33 <table border="0" width="100%" cellpadding="1" cellspacing="0" summary="">
       
    34 <tr>
       
    35 <td colspan="2" bgcolor="#eeeeff" class="navbarcell1">
       
    36 <a name="navbar_top_firstrow"><!-- --></a>
       
    37 <table border="0" cellpadding="0" cellspacing="3" summary="">
       
    38   <tr align="center" valign="top">
       
    39   <td bgcolor="#ffffff" class="navbarcell1"> &#160;<a href="overview-summary.html"><font class="navbarfont1"><b>overview</b></font>&#160;</a></td>
       
    40 
       
    41   <td bgcolor="#ffffff" class="navbarcell1">    <a href="deprecated-list.html"><font class="navbarfont1"><b>deprecated</b></font></a>&#160;</td>
       
    42     
       
    43   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="properties-table.html"><font class="navbarfont1"><b>properties-table</b></font></a>&#160;</td>  
       
    44   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="index-1.html"><font class="navbarfont1"><b>index</b></font></a>&#160;</td>
       
    45   <td bgcolor="#eeeeff" class="navbarcell1">    <a href="help.html"><font class="navbarfont1"><b>help</b></font></a>&#160;</td>
       
    46   </tr>
       
    47 </table>
       
    48 </td>
       
    49 <td align="right" valign="top" rowspan="3"><em>
       
    50 <b>Helium API</b></em>
       
    51 
       
    52 </td>
       
    53 </tr>
       
    54 
       
    55 <tr>
       
    56 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
    57 &#160;prev&#160;
       
    58 &#160;next</font></td>
       
    59 <td bgcolor="white" class="navbarcell2"><font size="-2">
       
    60   <a href="index.html?overview-summary.html" target="_top"><b>frames</b></a>  &#160;
       
    61 &#160;<a href="overview-summary.html" target="_top"><b>no frames</b></a>  &#160;
       
    62 
       
    63 &#160;<script type="text/javascript">
       
    64   <!--
       
    65   if(window==top) {
       
    66     document.writeln('<a href="allclasses-noframe.html"><b>all classes</b></a>');
       
    67   }
       
    68   //-->
       
    69 </script>
       
    70 <noscript>
       
    71   <a href="allclasses-noframe.html"><b>all classes</b></a>
       
    72 </noscript>
       
    73 
       
    74 
       
    75 </font></td>
       
    76 </tr>
       
    77 </table>
       
    78 <a name="skip-navbar_top"></a>
       
    79 <!-- ========= end of top navbar ========= -->
       
    80 </#macro>
       
    81 
       
    82 
       
    83 
       
    84 <#macro helium_api_head_section title>
       
    85 
       
    86 <head>
       
    87     <meta name="keywords" content="helium"/>
       
    88     <meta http-equiv="content-type" content="text/html+xml; charset=iso-8859-1"/>
       
    89     <link rel="stylesheet" href="stylesheet.css" type="text/css" />
       
    90     <script type="text/javascript">
       
    91       var DOCUMENTATION_OPTIONS = {
       
    92         URL_ROOT:   '',
       
    93         VERSION:    '0'
       
    94       };
       
    95     </script>
       
    96     <script type="text/javascript" src="../_static/jquery.js"></script>
       
    97 
       
    98     <script type="text/javascript" src="../_static/interface.js"></script>
       
    99     <script type="text/javascript" src="../_static/doctools.js"></script>
       
   100     
       
   101     <title>${title}</title>
       
   102 </head>
       
   103 
       
   104 </#macro>
       
   105 
       
   106 
       
   107 <#macro helium_api_header title>
       
   108 <?xml version="1.0" encoding="utf-8"?>
       
   109 <!DOCTYPE HTML PUBLIC "-//w3c//dtd xhtml 1.0 strict//en"
       
   110       "http://www.w3.org/tr/xhtml1/dtd/xhtml1-strict.dtd">
       
   111 <html xmlns="http://www.w3.org/1999/xhtml">
       
   112 
       
   113 <@helium_api_head_section title="${title}"/>
       
   114 
       
   115 <body>
       
   116     <@helium_api_navbar/>
       
   117     <hr/>
       
   118 </#macro>
       
   119 
       
   120 
       
   121 <#macro helium_api_html_footer>
       
   122     <hr/>
       
   123     <@helium_api_navbar/>
       
   124     <font size="-2">Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: http://www.eclipse.org/legal/epl-v10.html</font>
       
   125  </body>
       
   126 
       
   127 </html>
       
   128 
       
   129 </#macro>
       
   130 
       
   131 
       
   132 <#macro helium_api_location_path location>
       
   133     <#assign target_line=""/>
       
   134     <#assign res = location?matches(":(\\d+):$") />
       
   135     <#list res as m>
       
   136         <#assign target_line="#L${m?groups[1]}"/>
       
   137     </#list>      
       
   138     <#assign location_path=location/>
       
   139     <#if location?index_of("helium\\") &gt; 0>
       
   140         <#assign location_path=location?substring(location?last_index_of('helium\\'))/>
       
   141     </#if>
       
   142        <#assign target_url=location_path?replace("\\", "/")?replace(":(\\d+):", "", 'ri') />
       
   143     <tt class="docutils literal"><a href="${helium_browser_trunk}/${target_url}${target_line}">${location_path}</a></tt>  
       
   144 </#macro>
       
   145 
       
   146 <#macro helium_project_path location>
       
   147     <#assign location_path=location/>
       
   148     <#if location?index_of("helium\\") &gt; 0>
       
   149         <#assign location_path=location?substring(location?last_index_of('helium\\'))/>
       
   150     </#if>
       
   151        <#assign target_url=location_path?replace("\\", "/")?replace(":(\\d+):", "", 'ri') />
       
   152     <tt class="docutils literal"><a href="${helium_browser_trunk}/${target_url}">${target_url}</a></tt>  
       
   153 </#macro>
       
   154 
       
   155 <#-- Macros for recursively handling random HTML elements inside documentation elements. -->
       
   156 <#macro tt> <tt><#recurse></tt> </#macro>
       
   157 
       
   158 <#macro p><p><#recurse></p></#macro>
       
   159 
       
   160 <#macro ul><ul><#recurse></ul></#macro>
       
   161 
       
   162 <#macro li><li><#recurse></li></#macro>
       
   163 
       
   164 <#macro b><b><#recurse></b></#macro>
       
   165 
       
   166 <#macro pre><pre>${.node?html}</pre></#macro>
       
   167 
       
   168 <#macro @text>${.node?trim}</#macro>
       
   169