Merge remote-tracking branch 'upstream/master'
[matches/MCTX3420.git] / testing / MCTXWeb / public_html / help-Justin.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">
40       <div id="leftnav">
41         <a href="http://www.uwa.edu.au/" target="_blank">
42           <img alt = "The University of Western Australia"
43           src="static/uwacrest-text.png">
44         </a>
45         <span id="title">Help Documentation</span>
46       </div>
47       <div id="rightnav">
48         <span id="welcome-container">
49         </span>
50         <span id="date">
51           <script type="text/javascript">getDate();</script>
52         </span>
53         <div id="logout-container">
54           <form action="#">
55             <div>
56               <input type="button" id="logout" value="Logout">
57             </div>
58           </form>
59         </div>
60       </div>
61       <div class="clear"></div>
62     </div>
63     <!-- End header -->
64     
65     <div id="content">
66       <div id="sidebar">
67         <div class="widget">
68           <div class="title">Navigation menu</div>
69           <div class="nav-menu">
70           <ul>
71              <li><a href="index.html"><span>Home</span></a></li>
72              <li><a href="control.html"><span>Experiment control</span></a></li>
73              <li><a href="pintest.html"><span>Pin debugging</span></a></li>
74              <li class="last"><a href="#"><span>Help</span></a></li>
75           </ul>
76           </div>
77         </div>
78         <div class="widget">
79           <div class="title">Tutorials</div>
80           <p align="justify">For general information on using the MCTX project web interface (i.e. this webpage!) see the <b>'Tutorials'</b> section.
81                   This will guide you through setting up, running and analysing an experiment with basic tutorials and explanation of the possible options.</p>
82         </div>
83         <div class="widget">
84           <div class="title">Experiment Hardware</div>
85           <p align="justify">For detailed technical information about the experiment hardware, including system diagrams, datasheets and run-downs of the components,
86                   see the <b>'Hardware'</b> section.</p>
87         </div>
88         <div class="widget">
89           <div class="title">Experiment Software</div>
90           <p align="justify">For detailed technical information about the experiment software, including explanations of its structure, functions and so on, see the
91                   <b>'Software'</b> section. Actual code can be accessed on the project's GitHub: <a href="https://github.com/szmoore/MCTX3420">MCTX3420</a>.</p>
92         </div>
93         <div class="widget">
94           <div class="title">Contact</div>
95           <p align="justify">If you would like more information about the project or require additional assistance, please contact:</p>
96           <p><b>Adrian Keating</p>
97                   <p>Adam Wittek</b></p>
98         </div>
99       </div>
100       <!-- End sidebar -->
101
102       <div id="main">
103         <div class="widget">
104           <div class="title">Getting Started</div>
105                   <p align="justify">Welcome to the MCTX3420 project documentation! On this page, you will find help on how to use the project software, 
106                   as well as information about the various hardware components.</p>
107                   <p align="justify">For a basic introduction to using the experiment, see <b>'Tutorials'</b>.
108                   <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 
109                   <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.
110                   For detailed information about the experiment hardware, see the <b>'Hardware'</b> section. For detailed information about the project software, 
111                   see the <b>'Software'</b> section.</p>
112           <div class="sub-title">Tutorials</div>
113                   <ul>
114                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System overview</a></li>
115                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Web-Interface" target="_blank">Using the web interface</a></li>
116                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Run-an-Experiment" target="_blank">Running an experiment</a></li>
117                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-View-Old-Experiments" target="_blank">Viewing previous experiments</a></li>
118                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Data-Processing" target="_blank">Data processing</a></li>
119                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Safety" target="_blank">System safety</a></li>
120                   </ul>
121                   <div class="sub-title">Hardware</div>
122                     <ul>
123                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System overview</a></li>
124                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Electronics" target="_blank">Electronics</a></li>
125                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-BeagleBone" target="_blank">BeagleBone</a></li>
126                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Pneumatics" target="_blank">Pneumatics</a></li>
127                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Sensors" target="_blank">Sensors</a></li>
128                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Mounting" target="_blank">Mounting</a></li>
129                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Case" target="_blank">Case</a></li>
130                 </ul>
131                   <div class="sub-title">Software</div>
132                     <ul>
133                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Overview" target="_blank">Software overview</a></li>
134                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Browser-Interface" target="_blank">Browser interface</a></li>
135                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-API" target="_blank">Server API</a></li>
136                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-Code" target="_blank">Server code</a>
137                           <ul>
138                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Data-Handling" target="_blank">Data handling</a></li>
139                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Sensors-&amp;-Actuators" target="_blank">Sensors and actuators</a></li>
140                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Pin-Access" target="_blank">Pin access</a></li>
141                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Image-Processing" target="_blank">Image processing</a></li>
142                           </ul>
143                         </li>
144                         <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Terminology" target="_blank">Terminology</a></li>
145                         </ul>
146         </div>
147
148         <div class="widget">
149           <div class="title">Project Wiki</div>
150                     <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
151                         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>
152                         <p>The following is a list of pages on the GitHub wiki (all of which can be accessed via the categories above):<p>
153                         <ul>
154                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Data-Processing" target="_blank">Getting Started: Data Processing</a></li>
155                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Run-an-Experiment" target="_blank">Getting Started: Run an Experiment</a></li>
156                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-View-Old-Experiments" target="_blank">Getting Started: View Old Experiments</a></li>
157                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Getting-Started:-Web-Interface" target="_blank">Getting Started: Web Interface</a></li>
158                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-BeagleBone" target="_blank">Hardware: BeagleBone</a></li>
159                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Case" target="_blank">Hardware: Case</a></li>
160                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Electronics" target="_blank">Hardware: Electronics</a></li>
161                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Mounting" target="_blank">Hardware: Mounting</a></li>
162                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Pneumatics" target="_blank">Hardware: Pneumatics</a></li>
163                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Hardware:-Sensors" target="_blank">Hardware: Sensors</a></li>
164                           <li><a href="https://github.com/szmoore/MCTX3420/wiki" target="_blank">Home</a>
165                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Browser-Interface" target="_blank">Software: Browser Interface</a></li>
166                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Data-Handling" target="_blank">Software: Data Handling</a></li>
167                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Image-Processing" target="_blank">Software: Image Processing</a></li>
168                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Overview" target="_blank">Software: Overview</a></li>
169                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Pin-Access" target="_blank">Software: Pin Access</a></li>
170                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Sensors-&amp;-Actuators" target="_blank">Software: Sensors &amp; Actuators</a></li>
171                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-API" target="_blank">Software: Server API</a></li>
172                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Server-Code" target="_blank">Software: Server Code</a></li>
173                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/Software:-Terminology" target="_blank">Software: Terminology</a></li>
174                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Overview" target="_blank">System Overview</a></li>
175                           <li><a href="https://github.com/szmoore/MCTX3420/wiki/System-Safety" target="_blank">System Safety</a></li>
176                     </ul>
177         </div>
178       </div>
179       <!-- End main content -->
180     </div>
181   </body>
182 </html>

UCC git Repository :: git.ucc.asn.au