testing/MCTXWeb/public_html/help.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3   <head>
   4     <title>MCTX3420 Web Interface</title>
   5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   6     <script type="text/javascript" src="static/jquery-1.10.1.min.js"></script>
   7     <script type="text/javascript" src="static/mctx.gui.js"></script>
   8
   9     <link rel="stylesheet" type="text/css" href="static/style.css">
  10     <link rel="stylesheet" type="text/css" href="static/nav-menu.css">
  11     <script type="text/javascript">
  12       runBeforeLoad().done(function() {
  13         $(document).ready(function() {
  14           //Show the content!
  15           $("#content").css("display", "block");
  16           //Set the welcome bar
  17           var name = " " + (mctx.friendlyName ? mctx.friendlyName : "");
  18           $("#welcome-container").text("Welcome" + name + "!");
  19           $("#logout-container").css("display", "block");
  20           //$("#menu-container").populateNavbar();
  21
  22           $("#logout").click(function() {
  23             $("#logout").logout();
  24           });
  25
  26           $("#main_controls").submit(function() {
  27             //Validate!
  28             return false;
  29           });
  30
  31           $("#errorlog").setErrorLog();
  32         });
  33       })
  34
  35     </script>
  36   </head>
  37
  38   <body>
  39     <div id="header-wrap">
  40       <div id="header">
  41         <div id="leftnav">
  42           <a href="http://www.uwa.edu.au/" target="_blank">
  43             <img alt = "The University of Western Australia"
  44                  src="static/uwacrest-text.png">
  45           </a>
  46           <span id="title">Exploding Cans</span>
  47         </div>
  48         <div id="rightnav">
  49           <span id="welcome-container">
  50           </span>
  51           <span id="date">
  52             <script type="text/javascript">getDate();</script>
  53           </span>
  54           <div id="logout-container">
  55             <form action="#">
  56               <div>
  57                 <input type="button" id="logout" value="Logout">
  58               </div>
  59             </form>
  60           </div>
  61         </div>
  62         <div class="clear"></div>
  63       </div>
  64     </div>
  65     <!-- End header -->
  66
  67     <div id="content-wrap">
  68       <div id="content">
  69         <div id="sidebar">
  70           <div class="widget">
  71             <div class="title">Navigation menu</div>
  72             <div class="nav-menu">
  73               <ul>
  74                 <li><a href="index.html"><span>Home</span></a></li>
  75                 <li><a href="control.html"><span>Experiment control</span></a></li>
  76                 <li><a href="data.html"><span>Experiment data</span></a></li>
  77                 <li><a href="pintest.html"><span>Pin debugging</span></a></li>
  78                 <li class="last"><a href="help.html"><span>Help</span></a></li>
  79               </ul>
  80             </div>
  81           </div>
  82           <div class="widget justify">
  83             <div class="title">Tutorials</div>
  84             <p class="justify">For general information on using the MCTX project web interface (i.e. this webpage!) see the <b>'Tutorials'</b> section.
  85               This will guide you through setting up, running and analysing an experiment with basic tutorials and explanation of the possible options.</p>
  86           </div>
  87           <div class="widget justify">
  88             <div class="title">Experiment Hardware</div>
  89             <p class="justify">For detailed technical information about the experiment hardware, including system diagrams, datasheets and run-downs of the components,
  90               see the <b>'Hardware'</b> section.</p>
  91           </div>
  92           <div class="widget justify">
  93             <div class="title">Experiment Software</div>
  94             <p class="justify">For detailed technical information about the experiment software, including explanations of its structure, functions and so on, see the
  95               <b>'Software'</b> section. Actual code can be accessed on the project's GitHub: <a href="https://github.com/szmoore/MCTX3420">MCTX3420</a>.</p>
  96           </div>
  97           <div class="widget justify">
  98             <div class="title">Contact</div>
  99             <p class="justify">If you would like more information about the project or require additional assistance, please contact:</p>
 100             <p><b>Adrian Keating</b></p>
 101             <p><b>Adam Wittek</b></p>
 102           </div>
 103         </div>
 104         <!-- End sidebar -->
 105
 106         <div id="main">
 107           <div class="widget">
 108             <div class="title">Getting Started</div>
 109             <p class="justify">Welcome to the MCTX3420 project documentation! On this page, you will find help on how to use the project software,
 110               as well as information about the various hardware components.</p>
 111             <p class="justify">For a basic introduction to using the experiment, see <b>'Tutorials'</b>.
 112               <a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System overview</a> provides a general overview of the experiment's hardware, while
 113               <a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Web-Interface" target="_blank">Using the web interface</a> provides a tutorial on using the the project software.
 114               For detailed information about the experiment hardware, see the <b>'Hardware'</b> section. For detailed information about the project software,
 115               see the <b>'Software'</b> section.</p>
 116             <div class="sub-title">Tutorials</div>
 117             <ul>
 118               <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System overview</a></li>
 119               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Web-Interface" target="_blank">Using the web interface</a></li>
 120               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Run-an-Experiment" target="_blank">Running an experiment</a></li>
 121               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-View-Old-Experiments" target="_blank">Viewing previous experiments</a></li>
 122               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Data-Processing" target="_blank">Data processing</a></li>
 123               <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Safety" target="_blank">System safety</a></li>
 124             </ul>
 125             <div class="sub-title">Hardware</div>
 126             <ul>
 127               <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System overview</a></li>
 128               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Electronics" target="_blank">Electronics</a></li>
 129               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-BeagleBone" target="_blank">BeagleBone</a></li>
 130               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Pneumatics" target="_blank">Pneumatics</a></li>
 131               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Sensors" target="_blank">Sensors</a></li>
 132               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Mounting" target="_blank">Mounting</a></li>
 133               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Case" target="_blank">Case</a></li>
 134             </ul>
 135             <div class="sub-title">Software</div>
 136             <ul>
 137               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Overview" target="_blank">Software overview</a></li>
 138               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Browser-Interface" target="_blank">Browser interface</a></li>
 139               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-API" target="_blank">Server API</a></li>
 140               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-Code" target="_blank">Server code</a>
 141                 <ul>
 142                   <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Data-Handling" target="_blank">Data handling</a></li>
 143                   <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Sensors-&amp;-Actuators" target="_blank">Sensors and actuators</a></li>
 144                   <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Pin-Access" target="_blank">Pin access</a></li>
 145                   <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Image-Processing" target="_blank">Image processing</a></li>
 146                 </ul>
 147               </li>
 148               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Terminology" target="_blank">Terminology</a></li>
 149             </ul>
 150           </div>
 151
 152           <div class="widget">
 153             <div class="title">Project Wiki</div>
 154             <p>All of the project's help documentation is stored in its <a href="https://github.com/szmoore/MCTX3420/wiki" target="_blank">GitHub wiki.</a> This git repository also
 155               stores all of the software code for the project; to access the project code files, visit <a href="https://github.com/szmoore/MCTX3420" target="_blank">this link</a>.</p>
 156             <p>The following is a list of pages on the GitHub wiki (all of which can be accessed via the categories above):<p>
 157             <ul>
 158               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Data-Processing" target="_blank">Getting Started: Data Processing</a></li>
 159               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Run-an-Experiment" target="_blank">Getting Started: Run an Experiment</a></li>
 160               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-View-Old-Experiments" target="_blank">Getting Started: View Old Experiments</a></li>
 161               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Web-Interface" target="_blank">Getting Started: Web Interface</a></li>
 162               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-BeagleBone" target="_blank">Hardware: BeagleBone</a></li>
 163               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Case" target="_blank">Hardware: Case</a></li>
 164               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Electronics" target="_blank">Hardware: Electronics</a></li>
 165               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Mounting" target="_blank">Hardware: Mounting</a></li>
 166               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Pneumatics" target="_blank">Hardware: Pneumatics</a></li>
 167               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Sensors" target="_blank">Hardware: Sensors</a></li>
 168               <li><a href="https://github.com/szmoore/MCTX3420/wiki" target="_blank">Home</a>
 169               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Browser-Interface" target="_blank">Software: Browser Interface</a></li>
 170               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Data-Handling" target="_blank">Software: Data Handling</a></li>
 171               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Image-Processing" target="_blank">Software: Image Processing</a></li>
 172               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Overview" target="_blank">Software: Overview</a></li>
 173               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Pin-Access" target="_blank">Software: Pin Access</a></li>
 174               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Sensors-&amp;-Actuators" target="_blank">Software: Sensors &amp; Actuators</a></li>
 175               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-API" target="_blank">Software: Server API</a></li>
 176               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-Code" target="_blank">Software: Server Code</a></li>
 177               <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Terminology" target="_blank">Software: Terminology</a></li>
 178               <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System Overview</a></li>
 179               <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Safety" target="_blank">System Safety</a></li>
 180             </ul>
 181           </div>
 182         </div>
 183         <!-- End main content -->
 184       </div>
 185     </div>
 186   </body>
 187 </html>