doc/html/md_README.generic-table.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.11"/>
   7 <title>libwebsockets: Notes about generic-table</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtreedata.js"></script>
  14 <script type="text/javascript" src="navtree.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(initResizable);
  17   $(window).load(resizeHeight);
  18 </script>
  19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
  28   <td id="projectalign" style="padding-left: 0.5em;">
  29    <div id="projectname">libwebsockets
  30    </div>
  31    <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
  32   </td>
  33  </tr>
  34  </tbody>
  35 </table>
  36 </div>
  37 <!-- end header part -->
  38 <!-- Generated by Doxygen 1.8.11 -->
  39   <div id="navrow1" class="tabs">
  40     <ul class="tablist">
  41       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42       <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  43       <li><a href="modules.html"><span>Modules</span></a></li>
  44       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45       <li><a href="files.html"><span>Files</span></a></li>
  46     </ul>
  47   </div>
  48 </div><!-- top -->
  49 <div id="side-nav" class="ui-resizable side-nav-resizable">
  50   <div id="nav-tree">
  51     <div id="nav-tree-contents">
  52       <div id="nav-sync" class="sync"></div>
  53     </div>
  54   </div>
  55   <div id="splitbar" style="-moz-user-select:none;"
  56        class="ui-resizable-handle">
  57   </div>
  58 </div>
  59 <script type="text/javascript">
  60 $(document).ready(function(){initNavTree('md_README.generic-table.html','');});
  61 </script>
  62 <div id="doc-content">
  63 <div class="header">
  64   <div class="headertitle">
  65 <div class="title">Notes about generic-table </div>  </div>
  66 </div><!--header-->
  67 <div class="contents">
  68 <div class="textblock"><h2>What is generic-table? </h2>
  69 <p>Generic-table is a JSON schema and client-side JS file that makes it easy to display live, table structured HTML over a ws link.</p>
  70 <p>An example plugin and index.html using it are provided.</p>
  71 <h2>Enabling for build </h2>
  72 <p>Enable at CMake with -DLWS_WITH_PLUGINS=1</p>
  73 <h2>Generic-table JSON </h2>
  74 <h3>Column layout</h3>
  75 <p>When the ws connection is established, the protocol should send a JSON message describing the table columns. For example</p>
  76 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;msg = &quot;{\&quot;cols\&quot;:[&quot;</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;      &quot;  {\&quot;name\&quot;: \&quot;Date\&quot;},&quot;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;      &quot;  {\&quot;name\&quot;: \&quot;Size\&quot;, \&quot;align\&quot;: \&quot;right\&quot;},&quot;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;      &quot;  {\&quot;name\&quot;: \&quot;Icon\&quot;},&quot;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;      &quot;  {\&quot;name\&quot;: \&quot;Name\&quot;, \&quot;href\&quot;: \&quot;uri\&quot;},&quot;</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;      &quot;  {\&quot;name\&quot;: \&quot;uri\&quot;, \&quot;hide\&quot;: \&quot;1\&quot; }&quot;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;      &quot; ]&quot;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;      &quot;}&quot;;</div></div><!-- fragment --><ul>
  77 <li>This describes 5 columns</li>
  78 <li>Only four columns (not "uri") should be visible</li>
  79 <li>"Name" should be presented as a clickable link using "uri" as the destination, when a "uri" field is presented.</li>
  80 <li>"Size" field should be presented aligned to the right</li>
  81 </ul>
  82 <h3>Table data</h3>
  83 <p>The </p>
  84 </div></div><!-- contents -->
  85 </div><!-- doc-content -->
  86 <!-- start footer part -->
  87 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  88   <ul>
  89     <li class="footer">Generated by
  90     <a href="http://www.doxygen.org/index.html">
  91     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  92   </ul>
  93 </div>
  94 </body>
  95 </html>