contrib/luadoc/lua/luadoc/doclet/html/file.lp

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="<%=luadoc.doclet.html.link('luadoc.css', 'files/'..file_doc.name)%>" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22 <%=luadoc.doclet.html.include("menu.lp", { doc=doc, file_doc=file_doc })%>
  23
  24 </div> <!-- id="navigation" -->
  25
  26 <div id="content">
  27
  28 <h1>File <code><%=file_doc.name%></code></h1>
  29
  30 <%if file_doc.description then%>
  31 <p><%=file_doc.description%></p>
  32 <%end%>
  33 <%if file_doc.author then%>
  34 <p><b><%= #file_doc.author>1 and "Authors" or "Author" %>:</b>
  35 <table class="authors_list">
  36 <%for _, author in ipairs(file_doc.author) do%>
  37         <tr><td class="name"><%= author %></td></tr>
  38 <%end%>
  39 </table>
  40 </p>
  41 <%end%>
  42 <%if file_doc.copyright then%>
  43 <p>Copyright &copy;<%=file_doc.copyright%></p>
  44 <%end%>
  45 <%if file_doc.release then%>
  46 <p><small><b>Release:</b> <%=file_doc.release%></small></p>
  47 <%end%>
  48
  49 <%if #file_doc.functions > 0 then%>
  50 <h2>Functions</h2>
  51 <table class="function_list">
  52 <%for _, func_name in ipairs(file_doc.functions) do
  53   local func_data = file_doc.functions[func_name]%>
  54         <tr>
  55         <td class="name" nowrap><%=func_data.private and "local " or ""%><a href="#<%=func_name%>"><%=func_name%></a>&nbsp;(<%=table.concat(func_data.param, ", ")%>)</td>
  56         <td class="summary"><%=func_data.summary%></td>
  57         </tr>
  58 <%end%>
  59 </table>
  60 <%end%>
  61
  62
  63 <%if #file_doc.tables > 0 then%>
  64 <h2>Tables</h2>
  65 <table class="table_list">
  66 <%for _, tab_name in ipairs(file_doc.tables) do%>
  67         <tr>
  68         <td class="name" nowrap><a href="#<%=tab_name%>"><%=tab_name%></a></td>
  69         <td class="summary"><%=file_doc.tables[tab_name].summary%></td>
  70         </tr>
  71 <%end%>
  72 </table>
  73 <%end%>
  74
  75
  76 <br/>
  77 <br/>
  78
  79
  80
  81 <%if #file_doc.functions > 0 then%>
  82 <h2><a name="functions"></a>Functions</h2>
  83 <dl class="function">
  84 <%for _, func_name in ipairs(file_doc.functions) do%>
  85 <%=luadoc.doclet.html.include("function.lp", { doc=doc, file_doc=file_doc, func=file_doc.functions[func_name] })%>
  86 <%end%>
  87 </dl>
  88 <%end%>
  89
  90
  91 <%if #file_doc.tables > 0 then%>
  92 <h2><a name="tables"></a>Tables</h2>
  93 <dl class="table">
  94 <%for _, tab_name in ipairs(file_doc.tables) do%>
  95 <%=luadoc.doclet.html.include("table.lp", { doc=doc, file_doc=file_doc, tab=file_doc.tables[tab_name] })%>
  96 <%end%>
  97 </dl>
  98 <%end%>
  99
 100
 101
 102 </div> <!-- id="content" -->
 103
 104 </div> <!-- id="main" -->
 105
 106 <div id="about">
 107         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 108 </div> <!-- id="about" -->
 109
 110 </div> <!-- id="container" -->
 111 </body>
 112 </html>