index.html 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Orion</title>
  5. <link rel="StyleSheet" href="doc.css" type="text/css" media="screen"/>
  6. <link rel="StyleSheet" href="docprint.css" type="text/css" media="print"/>
  7. </head>
  8. <body>
  9. <div id="page">
  10. <div id="menu">
  11. <ul>
  12. <li>Index</li>
  13. <li><a href="admin.html">Installation and Administration</a></li>
  14. <li><a href="#RunApplet"><b>Orion</b> as a Java Applet</a></li>
  15. <li><a href="#RunApplication"><b>Orion</b> as a Java Application</a></li>
  16. <li><a href="keys.html">Key Mappings</a></li>
  17. <!--
  18. <li><a href="bugparade.html">Bug Parade</a></li>
  19. -->
  20. <li><a href="licenses.html">Licenses</a></li>
  21. </ul>
  22. </div>
  23. <div id="content">
  24. <h1>Orion</h1>
  25. <h2>What is Orion?</h2>
  26. <p><span class="Orion">Orion</span> is a Java application (in the loosest sense of
  27. the word) whose purpose is to allow the navigation of source code in a fast
  28. and simple manner.</p>
  29. <h2>Why Orion?</h2>
  30. <p>This product has gone through several names. First it was 'Cruise'. This was
  31. the name of a broadly equivalent tool within IBM. Then it was 'Orion'. Then it temporarily became 'Hound', and finally it came back to Orion. I hope that the name is now here to stay - I have had enough of the rebranding effort!</p>
  32. <h2 id="RunApplet">Running Orion as a Java Applet</h2>
  33. <p>There are no special requirements to run <span class="Orion">Orion</span> as an applet.
  34. You should contact your systems administrator who will ensure that a
  35. <span class="Orion">Orion</span> server is available, and will provide a URL for
  36. you to use.</p>
  37. <p><b><i>Note:</i> </b><span class="Orion">Orion</span> is a Java applet that uses Java 1.8 APIs.
  38. It is essential that your browser supports this fully.
  39. If you do not see the applet correctly, then you should consider upgrading
  40. your browser (and its Java Support) to the latest version.</p>
  41. <h3>Browser Support</h3>
  42. <p>In principal, the <span class="Orion">Orion</span> applet can be run in any Web browser that that
  43. has JNLP support enabled. It has a pre-requisite of Java 8 or greater.
  44. There have been browser compatability issues in the past and the invocation
  45. of the applet has been completely revamped. It is now hoped that a reliable mechanism has been found.
  46. <span class="Orion">Orion</span> (in its latest form) has been tested and
  47. runs successfully on:</p>
  48. <ul>
  49. <li>Internet Explorer 8.x</li>
  50. <li>Firefox 32</li>
  51. </ul>
  52. <p>Any problems concerning browser compatability should be reported to
  53. <a href="mailto:orion.support@ruelgnoj.co.uk?subject=Orion%20Browser%20Compatability">me</a>.</p>
  54. <h2 id="RunApplication">Running Orion as a Java Application</h2>
  55. <p>Before running <span class="Orion">Orion</span> as an application, you must have
  56. access to a tags file.
  57. See <a href="admin.html#TagsSetup">here</a> for information about creating a
  58. tags file.</p>
  59. <p><span class="Orion">Orion</span> usage is </p>
  60. <code>
  61. java -jar lib/orion.jar &lt;searchstring&gt;
  62. </code>
  63. <p>If <span class="Orion">Orion</span> is started with no parameters, a welcome screen is displayed, and
  64. you can type a 'hunt' string at the bottom of the window.</p>
  65. <p>If a search string is specified then the results of that search are displayed.</p>
  66. </div>
  67. <div id="copyright">
  68. <p><a href="http://ruelgnoj.co.uk/">Copyright &#169; 1997,2017 by Steve Millington. All Rights Reserved.</a></p>
  69. </div>
  70. </div>
  71. </body>
  72. </html>