]> matita.cs.unibo.it Git - helm.git/blob - helm/uwobo-panel/control.html
New: UWOBO profiles added.
[helm.git] / helm / uwobo-panel / control.html
1 <html>
2
3 <head>
4 <title>UWOBO Control Panel</title>
5
6 <style type="text/css">
7 #normal { background-color: white; font-family: sans-serif }
8 td.head { font-weight: bold; background-color: #e6e6fa; color: brown }
9 td.back { background-color: #e6e6fa; color: brown }
10 #indent { margin-left: 1cm; margin-right: 1cm }
11 </style>
12
13 <script language="JavaScript" src="control.js">
14 </script>
15
16 </head>
17
18 <body id="normal">
19 <a name="top"/>
20 <table border="0" width="100%" cellpadding="4">
21 <tr><td class="head" align="center"><big><big>UWOBO Control Panel</big></big></td></tr>
22 </table>
23
24 <br />
25
26 <div id="indent">
27 This is a control panel for the UWOBO Web-Service. You can control a local or remote UWOBO service by filling
28 the appropriate fields <a href="#params">below</a> and sending the desired commands. In most cases, results of commands, such as error
29 messages or documents, will be opened in the frame at the bottom of this page. For those commands sending multiple
30 requests to the UWOBO server, a new window will be opened for each request issued. Note that in order to use
31 this page <i>you must have JavaScript enabled</i>.
32
33 <br /><br />
34
35 The sections:
36 <ul>
37   <li><a href="#params">Global Parameters</a></li>
38   <li><a href="#sessions">Daemon Management</a></li>
39   <li><a href="#queries">Queries</a></li>
40   <li><a href="#profiles">Profiles</a></li>
41   <li><a href="#stylesheets">Stylesheet Management</a></li>
42   <li><a href="#process">Processing</a></li>
43 </ul>
44
45 In case you want to customize the panel for your own needs, you can download the source archive
46 (HTML + JavaScript):
47 <ul>
48   <li>UWOBO Panel [<a href="uwobo-panel.tar.gz">.tar.gz</a>]</li>
49 </ul>
50
51 </div>
52
53 <a name="params"/>
54 <table border="0" width="100%" cellpadding="4" cellspacing="0">
55 <tr>
56   <td class="head" align="left"><big>Global Parameters</big></td>
57   <td class="back" align="right"><a href="#top">top</a></td>
58 </tr>
59 </table>
60
61 <br />
62
63 <div id="indent">
64 The following are global parameters used by all the other section to contact the UWOBO service and possibly a
65 Getter. The Getter is not required for some operations and can be excluded by unchecking the proper buttons
66 below.
67
68 <br /><br />
69
70 The following is the URL used to contact the UWOBO Web-Service.
71 <tt>localhost</tt> is relative to your machine. 
72
73 <br /><br />
74
75 <table border="0">
76   <tr>
77     <th colspan="2" align="left">UWOBO URL</th>
78   </tr>
79   <tr>
80     <td>
81       <form name="uwoboURL">
82         <script>
83           document.write('<input type="text" value="' + getInitialProcessorURL() + '" size="50"/>');
84         </script>
85       </form>
86     </td>
87     <td>
88       <form>
89         <select onChange="selectUwoboURL(this)">
90           <option value="">---</option>
91           <option value="localhost">localhost</option>
92           <option value="marcello.cs.unibo.it">marcello</option>
93           <option value="phd.cs.unibo.it">phd</option>
94           <option value="eolo.cs.unibo.it">eolo</option>
95     <option value="helm.phd.cs.unibo.it">helm</option>
96         </select>
97       </form>
98     </td>
99     <td>
100       <form>
101         <input type="button" value="Check" onClick="top.result.location.replace(getUwoboURL() + 'help')"/>
102       </form>
103     </td>
104   </tr>
105 </table>
106
107 The following is the URL used to contact the getter. The getter is usually launched manually.
108 In all cases except for the check button below, 
109 <tt>localhost</tt> is relative to the host running UWOBO, because the getter URL is sent as
110 a parameter along with UWOBO commands. In other words, <tt>localhost</tt> <i>is</i> the host
111 running UWOBO and not your machine.
112
113 <br /><br />
114
115 <table border="0">
116   <tr>
117     <th colspan="2" align="left">Getter URL</th>
118   </tr>
119   <tr>
120     <td>
121       <form name="getterURL">
122         <script>
123           document.write('<input type="text" value="' + getInitialGetterURL() + '" size="50"/>');
124         </script>
125       </form>
126     </td>
127     <td>
128       <form>
129         <select onChange="selectGetterURL(this)">
130           <option value="">---</option>
131           <option value="localhost">localhost</option>
132           <option value="marcello.cs.unibo.it">marcello</option>
133           <option value="phd.cs.unibo.it">phd</option>
134           <option value="eolo.cs.unibo.it">eolo</option>
135         </select>
136       </form>
137     </td>
138     <td>
139       <form>
140         <input type="button" value="Check" onClick="top.result.location.replace(getGetterURL() + 'help')"/>
141       </form>
142     </td>
143   </tr>
144 </table>
145 </div>
146
147 <br />
148
149 <a name="sessions"/>
150 <table border="0" width="100%" cellpadding="4" cellspacing="0">
151 <tr>
152   <td class="head" align="left"><big>Daemon Management</big></td>
153   <td class="back" align="right"><a href="#top">top</a></td>
154 </tr>
155 </table>
156
157 <br />
158
159 <div id="indent">
160 <p>You can start a new daemon on a given port. The new daemon will have
161    an empty list of processed stylesheets.
162 </p>
163 <table border="0">
164   <tr>
165     <th colspan="2" align="left">Port</th>
166   </tr>
167   <tr>
168     <td>
169       <form name="sessions">
170         <script>
171           document.write('<input type="text" value="' + getInitialPort() + '" size="5"/>');
172         </script>
173       </form>
174     </td>
175     <td>
176       <form>
177         <input type="button" value="Start New Daemon" onClick="top.result.location.replace(getUwoboURL() + 'newsession?port=' + document.sessions.elements[0].value)"/>
178       </form>
179     </td>
180   </tr>
181 </table>
182 </div>
183
184 <br />
185
186 <div id="indent">
187 <p>You can also kill the daemon. The log file will be mantained.</p>
188 <table border="0">
189   <tr>
190     <td>
191       <form>
192         <input type="button" value="Stop Daemon" onClick="top.result.location.replace(getUwoboURL() + 'kill')"/>
193       </form>
194     </td>
195   </tr>
196 </table>
197 </div>
198
199 <br />
200 <a name="queries"/>
201 <table border="0" width="100%" cellpadding="4" cellspacing="0">
202 <tr>
203   <td class="head" align="left"><big>Queries</big></td>
204   <td class="back" align="right"><a href="#top">top</a></td>
205 </tr>
206 </table>
207
208 <div id="indent">
209
210 <br />
211
212 The following are commands to do some simple queries about the UWOBO service.
213
214 <br /><br />
215
216 <table border="0">
217 <tr>
218   <td>
219     Retrieve the version of the UWOBO service running at the UWOBO URL and list the syntax
220     of the accepted commands.
221     You can use this button to verify that a UWOBO service
222     is actually running there:
223   </td>
224 </tr>
225 <tr>
226   <td><form><input type="button" value="Help" onClick="top.result.location.replace(getUwoboURL() + 'help')"/></form></td>
227 </tr>
228 <tr>
229   <td>
230     Ask UWOBO for a list of the stylesheets currently compiled inside the Web-Service, along with their keys:
231   </td>
232 </tr>
233 <tr>
234   <td><form><input type="button" value="List Stylesheets" onClick="top.result.location.replace(getUwoboURL() + 'list')"/></form></td>
235 </tr>
236 </table>
237
238 <br />
239
240 </div>
241
242 <br />
243 <a name="profiles"/>
244 <table border="0" width="100%" cellpadding="4" cellspacing="0">
245 <tr>
246   <td class="head" align="left"><big>Profiles</big></td>
247   <td class="back" align="right"><a href="#top">top</a></td>
248 </tr>
249 </table>
250
251 <div id="indent">
252
253 <br />
254
255 The following are commands to list and edit the UWOBO profiles.
256
257 <br /><br />
258
259 <p><em>List existent profiles.</em></p>
260 <table border="0">
261 <tr>
262   <td><form><input type="button" value="List Profiles" onClick="top.result.location.replace(getUwoboURL() + 'listprofiles')"/></form></td>
263 </tr>
264 </table>
265
266 <p><em>Create a new profile.</em></p>
267 <table border="0">
268 <tr>
269   <th align="left">Name</th>
270   <th align="left">Parent profile</th>
271   <th align="left">Parent profile password</th>
272 </tr>
273 <tr>
274   <td>
275     <form name="createProfileID">
276       <input type="text" size="20"/>
277     </form>
278   </td>
279   <td>
280     <form name="createProfileClone">
281       <input type="text" size="20"/>
282     </form>
283   </td>
284   <td>
285     <form name="createProfilePassword">
286       <input type="text" size="20"/>
287     </form>
288   </td>
289   <td>
290     <form>
291       <input type="button" value="Create Profile" onClick="createProfile()"/>
292     </form>
293   </td>
294 </tr>
295 </table>
296
297 <p><em>Remove a profile.</em></p>
298 <table border="0">
299 <tr>
300   <th align="left">Name</th>
301   <th align="left">Password</th>
302 </tr>
303 <tr>
304   <td>
305     <form name="removeProfileID">
306       <input type="text" size="20"/>
307     </form>
308   </td>
309   <td>
310     <form name="removeProfilePassword">
311       <input type="text" size="20"/>
312     </form>
313   </td>
314   <td>
315     <form>
316       <input type="button" value="Remove Profile" onClick="removeProfile()"/>
317     </form>
318   </td>
319 </tr>
320 </table>
321
322 <p><em>Show profile parameters.</em></p>
323 <table border="0">
324 <tr>
325   <th align="left">Name</th>
326   <th align="left">Password</th>
327 </tr>
328 <tr>
329   <td>
330     <form name="getParamsProfileID">
331       <input type="text" size="20"/>
332     </form>
333   </td>
334   <td>
335     <form name="getParamsProfilePassword">
336       <input type="text" size="20"/>
337     </form>
338   </td>
339   <td>
340     <form>
341       <input type="button" value="Show Params" onClick="getProfileParams()"/>
342     </form>
343   </td>
344 </tr>
345 </table>
346
347 <p><em>Set profile parameters.</em></p>
348 <table border="0">
349 <tr>
350   <th align="left">Name</th>
351   <th align="left">Password</th>
352   <th align="left">Parameter name</th>
353   <th align="left">Parameter value</th>
354 </tr>
355 <tr>
356   <td>
357     <form name="setParamProfileID">
358       <input type="text" size="20"/>
359     </form>
360   </td>
361   <td>
362     <form name="setParamProfilePassword">
363       <input type="text" size="20"/>
364     </form>
365   </td>
366   <td>
367     <form name="setParamProfileKey">
368       <input type="text" size="20"/>
369     </form>
370   </td>
371   <td>
372     <form name="setParamProfileValue">
373       <input type="text" size="20"/>
374     </form>
375   </td>
376   <td>
377     <form>
378       <input type="button" value="Set Param" onClick="setProfileParam()"/>
379     </form>
380   </td>
381 </tr>
382 </table>
383
384 <br />
385
386 </div>
387
388 <a name="stylesheets"/>
389 <table border="0" width="100%" cellpadding="4" cellspacing="0">
390 <tr>
391   <td class="head" align="left"><big>Stylesheet Management</big></td>
392   <td class="back" align="right"><a href="#top">top</a></td>
393 </tr>
394 </table>
395
396 <div id="indent">
397
398 <br />
399
400 In this section you can add, remove and reload stylesheet into the server. There are
401 some frequently used stylesheets whose URIs and keys can be automatically filled in
402 by selecting one of the options of the box below. Note that for such stylesheets
403 the getter is used by default (you can deselect it, however):
404
405 <br /><br 7>
406
407 <table border="0">
408 <tr>
409   <th align="left">Predefined Stylesheets</th>
410 </tr>
411 <tr>
412   <td>
413     <form name="predefinedStylesheets">
414       <select size="1" onChange="selectPredefinedStylesheet(this)">
415         <option value="">---</option>
416         <option value="C1,rootcontent.xsl,true">CIC ==&gt; MathML Content</option>
417         <option value="TC1,objtheorycontent.xsl,true">CIC ==&gt; MathML Content (Show only the thesis)</option>
418         <option value="C2,annotatedpres.xsl,true">MathML Content ==&gt; MathML Presentation</option>
419         <option value="T1,theory_content.xsl,true">Theory CIC ==&gt; MathML Content</option>
420         <option value="T2,theory_pres.xsl,true">Theory Content ==&gt; MathML Presentation</option>
421         <option value="E,expandobj.xsl,true">Expander</option>
422         <option value="G,genmmlid.xsl,true">MathML Content ==&gt; MathML Content + IDs</option>
423         <option value="HC2,content_to_html.xsl,true">MathML Content ==&gt; HTML</option>
424         <option value="L,link.xsl,true">Resolve links</option>
425         <option value="d_c,drop_coercions.xsl,true">Drop implicit coercions</option>
426         <option value="meta_theory,mk_meta_theory.xsl,true">Metadata (back-pointers) to theory</option>
427         <option value="L2H,ls2html.xsl,true">Getter LS ==&gt; HTML</option>
428         <option value="L2T,ls2theory.xsl,true">Getter LS ==&gt; Theory</option>
429         <option value="GP,getParam.xsl,true">Get Param</option>
430         <option value="RT,resolve_topurl.xsl,true">Logic-sheet to substitute the interface URL</option>
431         <option value="MC,metadataControl.xsl,true">Stylesheet to create links to metadata</option>
432         <option value="MGL,makeGraphLinks.xsl,true">Add hyperlink menus to graphs</option>
433         <option value="MMG,mk_meta_graph.xsl,true">Make graph of backward dependencies</option>
434         <option value="MDG,mk_dep_graph.xsl,true">Make graph of dependencies</option>
435         <option value="HAT,hanane_textedepreuve2omdoc.xsl,true">Proof-Trees ==&gt; OMDoc</option>
436         <option value="HAO,hanane_omdoc2xhtml.xsl,true">OMDoc ==&gt; XHTML+MathML</option>
437       </select>
438     </form>
439   </td>
440   <td>
441     <form>
442       <input type="button" value="Load All Predefined" onClick="loadAllPredefined()"/>
443     </form>
444   </td>
445   <td>
446     <form>
447       <input type="button" value="Remove All Predefined" onClick="removeAllPredefined()"/>
448     </form>
449   </td>
450 </tr>
451 </table>
452
453 Here you have to identify a stylesheet by means of a relative or absolute URI. Usually
454 you will specify a relative URI when using the getter to retrieve the stylesheet.
455 Moreover, you can specify a key associated to this stylesheet, so that it will be easier to
456 refer to it in subsequent operations. If escaping is enabled, then the stylesheet URI will
457 be escaped. This might be particularly useful if the stylesheet is loaded by the getter.
458
459 <br /><br />
460
461 <table border="0">
462 <tr>
463   <th align="left">Stylesheet</th>
464   <th align="left">Key</th>
465   <th align="left">Use Getter</th>
466   <th align="left">Escape</th>
467 </tr>
468 <tr>
469   <td>
470     <form name="stylesheetURI">
471       <input type="text" size="50"/>
472     </form>
473   </td>
474   <td>
475     <form name="stylesheetKey">
476       <input type="text" size="10"/>
477     </form>
478   </td>
479   <td>
480     <form name="loadUseGetter">
481       <input type="checkbox" checked="true"/>
482     </form>
483   </td>
484   <td>
485     <form name="loadEscape">
486       <input type="checkbox" checked="true"/>
487     </form>
488   </td>
489   <td>
490     <form>
491       <input type="button" value="Load" onClick="loadStylesheet()"/>
492     </form>
493   </td>
494   <td>
495     <form>
496       <input type="button" value="Reload" onClick="reloadStylesheet()"/>
497     </form>
498   </td>
499   <td>
500     <form>
501       <input type="button" value="Remove" onClick="removeStylesheet()"/>
502     </form>
503   </td>
504 </tr>
505 </table>
506
507 Use the buttons below to remove or reload <i>all</i> the stylesheets.
508 Use these commands with
509 care, and remember that UWOBO can be shared among different users:
510
511 <br /><br />
512
513 <table border="0">
514 <tr>
515   <td>
516     <form>
517       <input type="button" value="Remove All" onClick="removeAllStylesheets()"/>
518     </form>
519   </td>
520   <td>
521     <form>
522       <input type="button" value="Reload All" onClick="reloadAllStylesheets()"/>
523     </form>
524   </td>
525 </tr>
526 </table>
527 </div>
528
529 <a name="process"/>
530 <table border="0" width="100%" cellpadding="4" cellspacing="0">
531 <tr>
532   <td class="head" align="left"><big>Processing</big></td>
533   <td class="back" align="right"><a href="#top">top</a></td>
534 </tr>
535 </table>
536
537 <div id="indent">
538
539 <br />
540
541 You can use the &quot;Apply&quot; command to perform a transformation. Specify the URI of the source
542 document in the form below. The URI can be relative or absolute (in the former case you
543 will probably want to enable the use of the getter).
544 If escaping is enabled, then special characters are escaped. This might be particularly useful
545 if the source is loaded by the getter.
546
547 <br /><br />
548
549 <table border="0">
550 <tr>
551   <th align="left">Source Document</th>
552   <th align="left">Escape</th>
553 </tr>
554 <tr>
555   <td>
556     <form name="sourceDocument">
557       <input type="text" size="50"/>
558     </form>
559   </td>
560   <td>
561     <form name="escapeSource">
562       <input type="checkbox" checked="true"/>
563     </form>
564   </td>
565 </tr>
566 </table>
567
568 You can specify a sequence of zero or more parameters separated by blanks. Each
569 parameter is made of a name immediately followed by <tt>=</tt> and then a value.
570 If &quot;Escape&quot; is checked, then parameters are escaped in the final
571 URI.
572
573 <br /><br />
574
575 <table border="0">
576 <tr>
577   <th align="left">Parameters (optional)</th>
578   <th align="left">Escape</th>
579 </tr>
580 <tr>
581   <td>
582     <form name="parameters">
583       <input type="text" size="50"/>
584     </form>
585   </td>
586   <td>
587     <form name="escapeParameters">
588       <input type="checkbox" checked="true"/>
589     </form>
590   </td>
591 </tr>
592 </table>
593
594 In the key list specify a list of keys
595 separated by blanks. This is the list of stylesheets to be applied in sequence to the
596 source document.
597 When ready, click on the button and have fun!
598
599 <br /><br />
600
601 <table border="0">
602 <tr>
603   <th align="left">Key list</th>
604   <th align="left">Use Getter</th>
605 </tr>
606 <tr>
607   <td>
608     <form name="keyList">
609       <input type="text" size="50"/>
610     </form>
611   </td>
612   <td>
613     <form name="applyUseGetter">
614       <input type="checkbox" checked="true"/>
615     </form>
616   </td>
617   <td>
618     <form>
619       <input type="button" value="Apply" onClick="applyStylesheets()"/>
620     </form>
621   </td>
622 </tr>
623 </table>
624
625 </div>
626
627 <table border="0" width="100%" cellpadding="4" cellspacing="0">
628 <tr>
629   <td class="back" align="left">Page maintained by: <a href="http://www.cs.unibo.it/~lpadovan">Luca Padovani</a></td>
630   <td class="back" align="right"><a href="#top">top</a></td>
631 </tr>
632 </table>
633
634 </body>
635
636 </html>
637