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