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="#sessions">Daemon Management</a></li>
  41   <li><a href="#queries">Queries</a></li>
  42   <li><a href="#stylesheets">Stylesheet Management</a></li>
  43   <li><a href="#process">Processing</a></li>
  44 </ul>
  45
  46 In case you want to customize the panel for your own needs, you can download the source archive
  47 (HTML + JavaScript):
  48 <ul>
  49   <li>UWOBO Panel [<a href="uwobo-panel.tar.gz">.tar.gz</a>]</li>
  50 </ul>
  51
  52 </div>
  53
  54 <a name="params"/>
  55 <table border="0" width="100%" cellpadding="4" cellspacing="0">
  56 <tr>
  57   <td class="head" align="left"><big>Global Parameters</big></td>
  58   <td class="back" align="right"><a href="#top">top</a></td>
  59 </tr>
  60 </table>
  61
  62 <br />
  63
  64 <div id="indent">
  65 The following are global parameters used by all the other section to contact the UWOBO servlet and possibly a
  66 getter. The getter is not required for some operations and can be excluded by unchecking the proper buttons
  67 below.
  68
  69 <br /><br />
  70
  71 The following is the URL used to contact the UWOBO servlet. Note that the servlet is usually launched by
  72 <a href="http://jakarta.apache.org" target="top">TOMCAT</a>. <tt>localhost</tt> is relative to your machine.
  73
  74 <br /><br />
  75
  76 <table border="0">
  77   <tr>
  78     <th colspan="2" align="left">UWOBO URL</th>
  79   </tr>
  80   <tr>
  81     <td>
  82       <form name="uwoboURL">
  83         <script>
  84           document.write('<input type="text" value="' + getInitialProcessorURL() + '" size="50"/>');
  85         </script>
  86       </form>
  87     </td>
  88     <td>
  89       <form>
  90         <select onChange="selectUwoboURL(this)">
  91           <option value="">---</option>
  92           <option value="localhost">localhost</option>
  93           <option value="marcello.cs.unibo.it">marcello</option>
  94           <option value="phd.cs.unibo.it">phd</option>
  95           <option value="eolo.cs.unibo.it">eolo</option>
  96     <option value="helm.phd.cs.unibo.it">helm</option>
  97         </select>
  98       </form>
  99     </td>
 100     <td>
 101       <form>
 102         <input type="button" value="Check" onClick="top.result.location.replace(getUwoboURL() + 'help')"/>
 103       </form>
 104     </td>
 105   </tr>
 106 </table>
 107
 108 The following is the URL used to contact the getter. The getter is usually launched manually.
 109 In all cases except for the check button below,
 110 <tt>localhost</tt> is relative to the host running UWOBO, because the getter URL is sent as
 111 a parameter along with UWOBO commands. In other words, <tt>localhost</tt> <i>is</i> the host
 112 running UWOBO and not your machine.
 113
 114 <br /><br />
 115
 116 <table border="0">
 117   <tr>
 118     <th colspan="2" align="left">Getter URL</th>
 119   </tr>
 120   <tr>
 121     <td>
 122       <form name="getterURL">
 123         <script>
 124           document.write('<input type="text" value="' + getInitialGetterURL() + '" size="50"/>');
 125         </script>
 126       </form>
 127     </td>
 128     <td>
 129       <form>
 130         <select onChange="selectGetterURL(this)">
 131           <option value="">---</option>
 132           <option value="localhost">localhost</option>
 133           <option value="marcello.cs.unibo.it">marcello</option>
 134           <option value="phd.cs.unibo.it">phd</option>
 135           <option value="eolo.cs.unibo.it">eolo</option>
 136         </select>
 137       </form>
 138     </td>
 139     <td>
 140       <form>
 141         <input type="button" value="Check" onClick="top.result.location.replace(getGetterURL() + 'help')"/>
 142       </form>
 143     </td>
 144   </tr>
 145 </table>
 146 </div>
 147
 148 <br />
 149
 150 <a name="sessions"/>
 151 <table border="0" width="100%" cellpadding="4" cellspacing="0">
 152 <tr>
 153   <td class="head" align="left"><big>Daemon Management</big></td>
 154   <td class="back" align="right"><a href="#top">top</a></td>
 155 </tr>
 156 </table>
 157
 158 <br />
 159
 160 <div id="indent">
 161 <p>You can start a new daemon on a given port. The new daemon will have
 162    an empty list of processed stylesheets.
 163 </p>
 164 <table border="0">
 165   <tr>
 166     <th colspan="2" align="left">Port</th>
 167   </tr>
 168   <tr>
 169     <td>
 170       <form name="sessions">
 171         <script>
 172           document.write('<input type="text" value="' + getInitialPort() + '" size="5"/>');
 173         </script>
 174       </form>
 175     </td>
 176     <td>
 177       <form>
 178         <input type="button" value="Start New Daemon" onClick="top.result.location.replace(getUwoboURL() + 'newsession?port=' + document.sessions.elements[0].value)"/>
 179       </form>
 180     </td>
 181   </tr>
 182 </table>
 183 </div>
 184
 185 <br />
 186
 187 <div id="indent">
 188 <p>You can also kill the daemon. The log file will be mantained.</p>
 189 <table border="0">
 190   <tr>
 191     <td>
 192       <form>
 193         <input type="button" value="Stop Daemon" onClick="top.result.location.replace(getUwoboURL() + 'kill')"/>
 194       </form>
 195     </td>
 196   </tr>
 197 </table>
 198 </div>
 199
 200 <br />
 201 <a name="queries"/>
 202 <table border="0" width="100%" cellpadding="4" cellspacing="0">
 203 <tr>
 204   <td class="head" align="left"><big>Queries</big></td>
 205   <td class="back" align="right"><a href="#top">top</a></td>
 206 </tr>
 207 </table>
 208
 209 <div id="indent">
 210
 211 <br />
 212
 213 The following are commands to do some simple queries about the UWOBO servlet.
 214
 215 <br /><br />
 216
 217 <table border="0">
 218 <tr>
 219   <td>
 220     Retrieve the version of the UWOBO servlet running at the UWOBO URL and list the syntax
 221     of the accepted commands.
 222     You can use this button to verify that a UWOBO servlet
 223     is actually running there:
 224   </td>
 225 </tr>
 226 <tr>
 227   <td><form><input type="button" value="Help" onClick="top.result.location.replace(getUwoboURL() + 'help')"/></form></td>
 228 </tr>
 229 <tr>
 230   <td>
 231     Ask UWOBO for a list of the stylesheets currently compiled inside the servlet, along with their keys:
 232   </td>
 233 </tr>
 234 <tr>
 235   <td><form><input type="button" value="List Stylesheets" onClick="top.result.location.replace(getUwoboURL() + 'list')"/></form></td>
 236 </tr>
 237 </table>
 238
 239 <br />
 240
 241 </div>
 242
 243 <a name="stylesheets"/>
 244 <table border="0" width="100%" cellpadding="4" cellspacing="0">
 245 <tr>
 246   <td class="head" align="left"><big>Stylesheet Management</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 In this section you can add, remove and reload stylesheet into the server. There are
 256 some frequently used stylesheets whose URIs and keys can be automatically filled in
 257 by selecting one of the options of the box below. Note that for such stylesheets
 258 the getter is used by default (you can deselect it, however):
 259
 260 <br /><br 7>
 261
 262 <table border="0">
 263 <tr>
 264   <th align="left">Predefined Stylesheets</th>
 265 </tr>
 266 <tr>
 267   <td>
 268     <form name="predefinedStylesheets">
 269       <select size="1" onChange="selectPredefinedStylesheet(this)">
 270         <option value="">---</option>
 271         <option value="C1,rootcontent.xsl,true">CIC ==&gt; MathML Content</option>
 272         <option value="TC1,objtheorycontent.xsl,true">CIC ==&gt; MathML Content (Show only the thesis)</option>
 273         <option value="C2,annotatedpres.xsl,true">MathML Content ==&gt; MathML Presentation</option>
 274         <option value="T1,theory_content.xsl,true">Theory CIC ==&gt; MathML Content</option>
 275         <option value="T2,theory_pres.xsl,true">Theory Content ==&gt; MathML Presentation</option>
 276         <option value="E,expandobj.xsl,true">Expander</option>
 277         <option value="G,genmmlid.xsl,true">MathML Content ==&gt; MathML Content + IDs</option>
 278         <option value="HC2,content_to_html.xsl,true">MathML Content ==&gt; HTML</option>
 279         <option value="L,link.xsl,true">Resolve links</option>
 280         <option value="d_c,drop_coercions.xsl,true">Drop implicit coercions</option>
 281         <option value="meta_theory,mk_meta_theory.xsl,true">Metadata (back-pointers) to theory</option>
 282         <option value="L2H,ls2html.xsl,true">Getter LS ==&gt; HTML</option>
 283         <option value="GP,getParam.xsl,true">Get Param</option>
 284         <option value="RT,resolve_topurl.xsl,true">Logic-sheet to substitute the interface URL</option>
 285         <option value="MC,metadataControl.xsl,true">Stylesheet to create links to metadata</option>
 286         <option value="MGL,makeGraphLinks.xsl,true">Add hyperlink menus to graphs</option>
 287         <option value="MMG,mk_meta_graph.xsl,true">Make graph of backward dependencies</option>
 288         <option value="MDG,mk_dep_graph.xsl,true">Make graph of dependencies</option>
 289       </select>
 290     </form>
 291   </td>
 292   <td>
 293     <form>
 294       <input type="button" value="Load All Predefined" onClick="loadAllPredefined()"/>
 295     </form>
 296   </td>
 297   <td>
 298     <form>
 299       <input type="button" value="Remove All Predefined" onClick="removeAllPredefined()"/>
 300     </form>
 301   </td>
 302 </tr>
 303 </table>
 304
 305 Here you have to identify a stylesheet by means of a relative or absolute URI. Usually
 306 you will specify a relative URI when using the getter to retrieve the stylesheet.
 307 Moreover, you can specify a key associated to this stylesheet, so that it will be easier to
 308 refer to it in subsequent operations. If escaping is enabled, then the stylesheet URI will
 309 be escaped. This might be particularly useful if the stylesheet is loaded by the getter.
 310
 311 <br /><br />
 312
 313 <table border="0">
 314 <tr>
 315   <th align="left">Stylesheet</th>
 316   <th align="left">Key</th>
 317   <th align="left">Use Getter</th>
 318   <th align="left">Escape</th>
 319 </tr>
 320 <tr>
 321   <td>
 322     <form name="stylesheetURI">
 323       <input type="text" size="50"/>
 324     </form>
 325   </td>
 326   <td>
 327     <form name="stylesheetKey">
 328       <input type="text" size="10"/>
 329     </form>
 330   </td>
 331   <td>
 332     <form name="loadUseGetter">
 333       <input type="checkbox" checked="true"/>
 334     </form>
 335   </td>
 336   <td>
 337     <form name="loadEscape">
 338       <input type="checkbox" checked="true"/>
 339     </form>
 340   </td>
 341   <td>
 342     <form>
 343       <input type="button" value="Load" onClick="loadStylesheet()"/>
 344     </form>
 345   </td>
 346   <td>
 347     <form>
 348       <input type="button" value="Reload" onClick="reloadStylesheet()"/>
 349     </form>
 350   </td>
 351   <td>
 352     <form>
 353       <input type="button" value="Remove" onClick="removeStylesheet()"/>
 354     </form>
 355   </td>
 356 </tr>
 357 </table>
 358
 359 Use the buttons below to remove or reload <i>all</i> the stylesheets inside the servlet. Use these commands with
 360 care, and remember that the servlet can be shared among different users:
 361
 362 <br /><br />
 363
 364 <table border="0">
 365 <tr>
 366   <td>
 367     <form>
 368       <input type="button" value="Remove All" onClick="removeAllStylesheets()"/>
 369     </form>
 370   </td>
 371   <td>
 372     <form>
 373       <input type="button" value="Reload All" onClick="reloadAllStylesheets()"/>
 374     </form>
 375   </td>
 376 </tr>
 377 </table>
 378 </div>
 379
 380 <a name="process"/>
 381 <table border="0" width="100%" cellpadding="4" cellspacing="0">
 382 <tr>
 383   <td class="head" align="left"><big>Processing</big></td>
 384   <td class="back" align="right"><a href="#top">top</a></td>
 385 </tr>
 386 </table>
 387
 388 <div id="indent">
 389
 390 <br />
 391
 392 You can use the &quot;Apply&quot; command to perform a transformation. Specify the URI of the source
 393 document in the form below. The URI can be relative or absolute (in the former case you
 394 will probably want to enable the use of the getter).
 395 If escaping is enabled, then special characters are escaped. This might be particularly useful
 396 if the source is loaded by the getter.
 397
 398 <br /><br />
 399
 400 <table border="0">
 401 <tr>
 402   <th align="left">Source Document</th>
 403   <th align="left">Escape</th>
 404 </tr>
 405 <tr>
 406   <td>
 407     <form name="sourceDocument">
 408       <input type="text" size="50"/>
 409     </form>
 410   </td>
 411   <td>
 412     <form name="escapeSource">
 413       <input type="checkbox" checked="true"/>
 414     </form>
 415   </td>
 416 </tr>
 417 </table>
 418
 419 You can specify a sequence of zero or more parameters separated by blanks. Each
 420 parameter is made of a name immediately followed by <tt>=</tt> and then a value.
 421 If &quot;Escape&quot; is checked, then parameters are escaped in the final
 422 URI.
 423
 424 <br /><br />
 425
 426 <table border="0">
 427 <tr>
 428   <th align="left">Parameters (optional)</th>
 429   <th align="left">Escape</th>
 430 </tr>
 431 <tr>
 432   <td>
 433     <form name="parameters">
 434       <input type="text" size="50"/>
 435     </form>
 436   </td>
 437   <td>
 438     <form name="escapeParameters">
 439       <input type="checkbox" checked="true"/>
 440     </form>
 441   </td>
 442 </tr>
 443 </table>
 444
 445 In the key list specify a list of keys
 446 separated by blanks. This is the list of stylesheets to be applied in sequence to the
 447 source document.
 448 When ready, click on the button and have fun!
 449
 450 <br /><br />
 451
 452 <table border="0">
 453 <tr>
 454   <th align="left">Key list</th>
 455   <th align="left">Use Getter</th>
 456 </tr>
 457 <tr>
 458   <td>
 459     <form name="keyList">
 460       <input type="text" size="50"/>
 461     </form>
 462   </td>
 463   <td>
 464     <form name="applyUseGetter">
 465       <input type="checkbox" checked="true"/>
 466     </form>
 467   </td>
 468   <td>
 469     <form>
 470       <input type="button" value="Apply" onClick="applyStylesheets()"/>
 471     </form>
 472   </td>
 473 </tr>
 474 </table>
 475
 476 </div>
 477
 478 <table border="0" width="100%" cellpadding="4" cellspacing="0">
 479 <tr>
 480   <td class="back" align="left">Page maintained by: <a href="mailto:luca.padovani@cs.unibo.it">Luca Padovani</a></td>
 481   <td class="back" align="right"><a href="#top">top</a></td>
 482 </tr>
 483 </table>
 484
 485 </body>
 486
 487 </html>
 488