00001 /**
00002
00003 <p>
00004 This is the self-generated documentation for RexxLiterate pre-alpha
00005 1.
00006 </p>
00007
00008 <h3> Overview</h3>
00009 <p>
00010 Currently, all of the tabs above work, showing you various views of
00011 the RexxLiterate code as files, code features, and source. The tabs
00012 provide indexing and cross referencing.
00013 </p>
00014
00015 <p>
00016 The source browser features syntax highlighting.
00017 </p>
00018
00019 <p>
00020 You can also navigate the tree on the left to explore the feature
00021 documentation and source.
00022 </p>
00023
00024 <p>
00025 Feature documentation is present and complete. The source browser
00026 features syntax highlighting.
00027 </p>
00028
00029 <h3>Licence</h3>
00030 <p>
00031 This version of RexxLiterate is licensed under the Common Public
00032 License
00033 <a href="http://www.opensource.org/licenses/cpl1.0.php">http://www.opensource.org/licenses/cpl1.0.php</a>
00034 </p>
00035
00036 <p>
00037 Copyright (c) 2004-2010 William Data Systems and Geoff Stevens
00038 </p>
00039
00040 <p>
00041 Commercial licences including full support and maintenance are
00042 available by negotiation with William Data Systems. Find your local
00043 office at
00044 <a href="http://www.willdata.com">http://www.willdata.com</a>
00045 </p>
00046 <p>
00047 Author: Geoff Stevens
00048 </p>
00049
00050 <h3>Structure</h3>
00051 <p>
00052 Click on the <i>documents</i> tab above, then on the <i>Structure</i> link.
00053 </p>
00054
00055 <h3>Operation</h3>
00056 <p>
00057 This guide assumes you're familiar with editing and running Rexx
00058 programs in your environment.
00059 </p>
00060
00061 <p>
00062 Examine the program <b>rexxliterate.rex</b> (click on the Programs
00063 tab at the top of this page).
00064 </p>
00065
00066 <p>
00067 As supplied, the program produces documentation for the programs in
00068 the current working directory, producing the output in a folder
00069 called ./html, which produces documentation for itself.
00070 </p>
00071
00072 <p>
00073 Edit <b>rexxliterate.rex</b> to make the variable <i>rsource</i>
00074 point at a folder with some rexx programs in, and <i>htarget</i> to
00075 point at an existing folder you don't mind getting HTML written
00076 into.
00077 </p>
00078
00079 <p>
00080 Then execute <b>rexxliterate.rex</b> using an OORexx 3.2.0 or
00081 higher.
00082 </p>
00083
00084 <p>
00085 Examine output in <i>htarget</i>.
00086 </p>
00087 */
00088
00089
00090 /** Structure - how the program fits together
00091 <p>
00092 RexxLiterate is composed of a lightweight executable and three
00093 libraries.
00094 </p>
00095 <p>
00096 The library comprised of <i>rexxprogram.cls</i> is a general purpose
00097 Rexx source parser. It is uncoupled to the other libraries.
00098 </p>
00099 <p>
00100 The document library in <i>hrdocuments.cls</i> can parse rexx (using
00101 <i>rexxprogram.cls</i>) or text files into <i>rexxdocument</i> or
00102 <i>textdocument</i> objects which can render themselves as HTML. The
00103 library also provides representations of files and folders which can
00104 be built into a tree. It is coupled to the rexx parser library.
00105 </p>
00106 <p>
00107 The tree library in <i>htmltree.cls</i> will take a tree of
00108 <i>file</i> and <i>folder</i> objects and render a navigable HTML
00109 representation of the tree. It is closely coupled to the document
00110 library.
00111 </p>
00112 <p>
00113 The <i>htmlrexx</i> class provides a service to navigate the
00114 filesystem and manage the parsing and emitting of HTML documents for
00115 all files found there, optionally with a tree view provided. It also
00116 manages global lists for the set of Rexx programs, emitting the
00117 top-level tabbed HTML pages and lists.
00118 </p>
00119 <p>
00120 The lightweight executable <b>rexxliterate.rex</b> sets up some
00121 parameters and creates an <i>htmlrexx</i> object with them, which
00122 coordinates the heavy lifting.
00123 </p>
00124
00125 */
00126
00127
00128 /** Todo
00129 <p>
00130 More cross referencing. ::REQUIRES targets in particular, but this needs
00131 disambiguation by path (done) A list of required but unavailable source
00132 files would be good. Instantiations of known classes should be xref-ed in
00133 the source (done, with all class methods).
00134 </p>
00135 <p>
00136 Some of the tabs destinations might be better: should a ROUTINE display its
00137 File Reference page within Files, or be on the Routines tab?
00138 </p>
00139 <p>
00140 Labels contained in a method should be suppressed from the File Reference
00141 page (some label suppression done).
00142 </p>
00143 <p>
00144 Are two sizes of icon file really necessary?
00145 </p>
00146
00147
00148 */
0.0.1