]> matita.cs.unibo.it Git - helm.git/blob - helm/uwobo-panel/control.html
Initial revision
[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 servlet. You can control a local or remote UWOBO servlet 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 If you have troubles, please send an email to the author:
33 <a href="mailto:luca.padovani@cs.unibo.it">luca.padovani@cs.unibo.it</a>
34
35 <br /><br />
36
37 The sections:
38 <ul>
39   <li><a href="#params">Global Parameters</a></li>
40   <li><a href="#queries">Queries</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 servlet 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 servlet. Note that the servlet is usually launched by
71 <a href="http://jakarta.apache.org" target="top">TOMCAT</a>. <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         </select>
96       </form>
97     </td>
98     <td>
99       <form>
100         <input type="button" value="Check" onClick="top.result.location.replace(getUwoboURL() + 'help')"/>
101       </form>
102     </td>
103   </tr>
104 </table>
105
106 The following is the URL used to contact the getter. The getter is usually launched manually.
107 In all cases except for the check button below, 
108 <tt>localhost</tt> is relative to the host running UWOBO, because the getter URL is sent as
109 a parameter along with UWOBO commands. In other words, <tt>localhost</tt> <i>is</i> the host
110 running UWOBO and not your machine.
111
112 <br /><br />
113
114 <table border="0">
115   <tr>
116     <th colspan="2" align="left">Getter URL</th>
117   </tr>
118   <tr>
119     <td>
120       <form name="getterURL">
121         <script>
122           document.write('<input type="text" value="' + getInitialGetterURL() + '" size="50"/>');
123         </script>
124       </form>
125     </td>
126     <td>
127       <form>
128         <select onChange="selectGetterURL(this)">
129           <option value="">---</option>
130           <option value="localhost">localhost</option>
131           <option value="marcello.cs.unibo.it">marcello</option>
132           <option value="phd.cs.unibo.it">phd</option>
133           <option value="eolo.cs.unibo.it">eolo</option>
134         </select>
135       </form>
136     </td>
137     <td>
138       <form>
139         <input type="button" value="Check" onClick="top.result.location.replace(getGetterURL() + 'help')"/>
140       </form>
141     </td>
142   </tr>
143 </table>
144 </div>
145
146 <a name="queries"/>
147 <table border="0" width="100%" cellpadding="4" cellspacing="0">
148 <tr>
149   <td class="head" align="left"><big>Queries</big></td>
150   <td class="back" align="right"><a href="#top">top</a></td>
151 </tr>
152 </table>
153
154 <div id="indent">
155
156 <br />
157
158 The following are commands to do some simple queries about the UWOBO servlet.
159
160 <br /><br />
161
162 <table border="0">
163 <tr>
164   <td>
165     Retrieve the version of the UWOBO servlet running at the UWOBO URL and list the syntax
166     of the accepted commands.
167     You can use this button to verify that a UWOBO servlet
168     is actually running there:
169   </td>
170 </tr>
171 <tr>
172   <td><form><input type="button" value="Help" onClick="top.result.location.replace(getUwoboURL() + 'help')"/></form></td>
173 </tr>
174 <tr>
175   <td>
176     Ask UWOBO for a list of the stylesheets currently compiled inside the servlet, along with their keys:
177   </td>
178 </tr>
179 <tr>
180   <td><form><input type="button" value="List Stylesheets" onClick="top.result.location.replace(getUwoboURL() + 'list')"/></form></td>
181 </tr>
182 </table>
183
184 <br />
185
186 </div>
187
188 <a name="stylesheets"/>
189 <table border="0" width="100%" cellpadding="4" cellspacing="0">
190 <tr>
191   <td class="head" align="left"><big>Stylesheet Management</big></td>
192   <td class="back" align="right"><a href="#top">top</a></td>
193 </tr>
194 </table>
195
196 <div id="indent">
197
198 <br />
199
200 In this section you can add, remove and reload stylesheet into the server. There are
201 some frequently used stylesheets whose URIs and keys can be automatically filled in
202 by selecting one of the options of the box below. Note that for such stylesheets
203 the getter is used by default (you can deselect it, however):
204
205 <br /><br 7>
206
207 <table border="0">
208 <tr>
209   <th align="left">Predefined Stylesheets</th>
210 </tr>
211 <tr>
212   <td>
213     <form name="predefinedStylesheets">
214       <select size="1" onChange="selectPredefinedStylesheet(this)">
215         <option value="">---</option>
216         <option value="C1,rootcontent.xsl,true">CIC ==&gt; MathML Content</option>
217         <option value="TC1,objtheorycontent.xsl,true">CIC ==&gt; MathML Content (Show only the thesis)</option>
218         <option value="C2,annotatedpres.xsl,true">MathML Content ==&gt; MathML Presentation</option>
219         <option value="T1,theory_content.xsl,true">Theory CIC ==&gt; MathML Content</option>
220         <option value="T2,theory_pres.xsl,true">Theory Content ==&gt; MathML Presentation</option>
221         <option value="E,expandobj.xsl,true">Expander</option>
222         <option value="G,genmmlid.xsl,true">MathML Content ==&gt; MathML Content + IDs</option>
223         <option value="HC2,content_to_html.xsl,true">MathML Content ==&gt; HTML</option>
224         <option value="L,link.xsl,true">Resolve links</option>
225         <option value="d_c,drop_coercions.xsl,true">Drop implicit coercions</option>
226         <option value="meta_theory,mk_meta_theory.xsl,true">Metadata (back-pointers) to theory</option>
227         <option value="L2H,ls2html.xsl,true">Getter LS ==&gt; HTML</option>
228         <option value="GP,getParam.xsl,true">Get Param</option>
229         <option value="RT,resolve_topurl.xsl,true">Logic-sheet to substitute the interface URL</option>
230         <option value="MC,metadataControl.xsl,true">Stylesheet to create links to metadata</option>
231         <option value="MGL,makeGraphLinks.xsl,true">Add hyperlink menus to graphs</option>
232         <option value="MMG,mk_meta_graph.xsl,true">Make graph of backward dependencies</option>
233         <option value="MDG,mk_dep_graph.xsl,true">Make graph of dependencies</option>
234       </select>
235     </form>
236   </td>
237   <td>
238     <form>
239       <input type="button" value="Load All Predefined" onClick="loadAllPredefined()"/>
240     </form>
241   </td>
242   <td>
243     <form>
244       <input type="button" value="Remove All Predefined" onClick="removeAllPredefined()"/>
245     </form>
246   </td>
247 </tr>
248 </table>
249
250 Here you have to identify a stylesheet by means of a relative or absolute URI. Usually
251 you will specify a relative URI when using the getter to retrieve the stylesheet.
252 Moreover, you can specify a key associated to this stylesheet, so that it will be easier to
253 refer to it in subsequent operations. If escaping is enabled, then the stylesheet URI will
254 be escaped. This might be particularly useful if the stylesheet is loaded by the getter.
255
256 <br /><br />
257
258 <table border="0">
259 <tr>
260   <th align="left">Stylesheet</th>
261   <th align="left">Key</th>
262   <th align="left">Use Getter</th>
263   <th align="left">Escape</th>
264 </tr>
265 <tr>
266   <td>
267     <form name="stylesheetURI">
268       <input type="text" size="50"/>
269     </form>
270   </td>
271   <td>
272     <form name="stylesheetKey">
273       <input type="text" size="10"/>
274     </form>
275   </td>
276   <td>
277     <form name="loadUseGetter">
278       <input type="checkbox" checked="true"/>
279     </form>
280   </td>
281   <td>
282     <form name="loadEscape">
283       <input type="checkbox" checked="true"/>
284     </form>
285   </td>
286   <td>
287     <form>
288       <input type="button" value="Load" onClick="loadStylesheet()"/>
289     </form>
290   </td>
291   <td>
292     <form>
293       <input type="button" value="Reload" onClick="reloadStylesheet()"/>
294     </form>
295   </td>
296   <td>
297     <form>
298       <input type="button" value="Remove" onClick="removeStylesheet()"/>
299     </form>
300   </td>
301 </tr>
302 </table>
303
304 Use the buttons below to remove or reload <i>all</i> the stylesheets inside the servlet. Use these commands with
305 care, and remember that the servlet can be shared among different users:
306
307 <br /><br />
308
309 <table border="0">
310 <tr>
311   <td>
312     <form>
313       <input type="button" value="Remove All" onClick="removeAllStylesheets()"/>
314     </form>
315   </td>
316   <td>
317     <form>
318       <input type="button" value="Reload All" onClick="top.result.location.replace(getUwoboURL() + 'reload')"/>
319     </form>
320   </td>
321 </tr>
322 </table>
323 </div>
324
325 <a name="process"/>
326 <table border="0" width="100%" cellpadding="4" cellspacing="0">
327 <tr>
328   <td class="head" align="left"><big>Processing</big></td>
329   <td class="back" align="right"><a href="#top">top</a></td>
330 </tr>
331 </table>
332
333 <div id="indent">
334
335 <br />
336
337 You can use the &quot;Apply&quot; command to perform a transformation. Specify the URI of the source
338 document in the form below. The URI can be relative or absolute (in the former case you
339 will probably want to enable the use of the getter).
340 If escaping is enabled, then special characters are escaped. This might be particularly useful
341 if the source is loaded by the getter.
342
343 <br /><br />
344
345 <table border="0">
346 <tr>
347   <th align="left">Source Document</th>
348   <th align="left">Escape</th>
349 </tr>
350 <tr>
351   <td>
352     <form name="sourceDocument">
353       <input type="text" size="50"/>
354     </form>
355   </td>
356   <td>
357     <form name="escapeSource">
358       <input type="checkbox" checked="true"/>
359     </form>
360   </td>
361 </tr>
362 </table>
363
364 You can specify a sequence of zero or more parameters separated by blanks. Each
365 parameter is made of a name immediately followed by <tt>=</tt> and then a value.
366 If &quot;Escape&quot; is checked, then parameters are escaped in the final
367 URI.
368
369 <br /><br />
370
371 <table border="0">
372 <tr>
373   <th align="left">Parameters (optional)</th>
374   <th align="left">Escape</th>
375 </tr>
376 <tr>
377   <td>
378     <form name="parameters">
379       <input type="text" size="50"/>
380     </form>
381   </td>
382   <td>
383     <form name="escapeParameters">
384       <input type="checkbox" checked="true"/>
385     </form>
386   </td>
387 </tr>
388 </table>
389
390 In the key list specify a list of keys
391 separated by blanks. This is the list of stylesheets to be applied in sequence to the
392 source document.
393 When ready, click on the button and have fun!
394
395 <br /><br />
396
397 <table border="0">
398 <tr>
399   <th align="left">Key list</th>
400   <th align="left">Use Getter</th>
401 </tr>
402 <tr>
403   <td>
404     <form name="keyList">
405       <input type="text" size="50"/>
406     </form>
407   </td>
408   <td>
409     <form name="applyUseGetter">
410       <input type="checkbox" checked="true"/>
411     </form>
412   </td>
413   <td>
414     <form>
415       <input type="button" value="Apply" onClick="applyStylesheets()"/>
416     </form>
417   </td>
418 </tr>
419 </table>
420
421 </div>
422
423 <table border="0" width="100%" cellpadding="4" cellspacing="0">
424 <tr>
425   <td class="back" align="left">Page maintained by: <a href="mailto:luca.padovani@cs.unibo.it">Luca Padovani</a></td>
426   <td class="back" align="right"><a href="#top">top</a></td>
427 </tr>
428 </table>
429
430 </body>
431
432 </html>
433