::CLASS htmlout PUBLIC

render a series of parsed rexx documents as HTML
this class exists to aggregate the knowledge of the html renderers

Requires

'fsobjects.cls' for all the boilerplate
'documents.cls' files, folders, rexx and text documents
'nodes.cls' html images to build the tree view
'htmlrexxprogram.cls' html page builders
'htmlrexxclass.cls'
'htmlrexxsource.cls'
'htmltext.cls'
Definition at line 64 of htmlout.cls

Public Methods

  firstpage (docs, treeframe)
no comment
  init (rexxliterate, hdest, pversion, title, prefixcomment, trailericon)
  modpage (module)
write modules page
  modules (modules)
no comment
block comment with prefix removed noprefix (bc)
remove prefix from block comment
  rhtmlpage (folder, file, globalix)
emit html pages for rexx program
  tabshead (outq, tablist, selector)
add a tabs header to a queue
  thtmlpage (folder, file)
emit html page for text file

Public Attributes

  hdest
  pmissingdoc
queue of messages describing parameters with no docs
  prefixcomment
remove from comment prefix
  pversion
  pwrongdoc
queue of messages describing parameter docs not matching code
  rexxliterate
owner rexxliterate
  title
name of report
  topmenu
top menu structure
  trailericon
tag to add to to left of trailer pages

Private Methods

  repcode (text)
write modules page

Instantiated by

rexxliterate.cls line 214

Feature Detail

::ATTRIBUTE hdest

Definition at line 65 of htmlout.cls
Dynamically referenced by
htmlindex.cls line 123 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 163 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 199 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 225 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 248 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 271 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 293 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 316 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 345 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 367 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlindex.cls line 398 "call hiea2html elem~makeArray, indexfile, '', htmlout~hdest, 80, hdr, trl"
htmlout.cls line 81 "self~hdest = hdest"
htmlout.cls line 129 "towrite = self~hdest||'documents.html'"
htmlout.cls line 149 "towrite = self~hdest||'MOD_'module~modname'.html'"
htmlout.cls line 196 "towrite = self~hdest||'main.html'"
htmlout.cls line 202 "towrite = self~hdest||'index.html'"
htmlrexxclass.cls line 199 "towrite = self~htmlout~hdest||rdc~hdocurl"
htmlrexxprogram.cls line 257 "towrite = htmlout~hdest||file~document~hdocurl"
htmlrexxsource.cls line 105 "towrite = self~htmlout~hdest||file~document~hsrcurl"
htmltext.cls line 92 "towrite = htmlout~hdest||file~document~hsrcurl"
rexxliterate.cls line 163 "self~hdest = config~hdest"
rexxliterate.rex line 102 "config~hdest = .pathsep~localpath(hdest)"
test.rex line 102 "config~hdest = .pathsep~localpath(hdest)"

::ATTRIBUTE pversion

Definition at line 66 of htmlout.cls
Dynamically referenced by
htmlout.cls line 82 "self~pversion = pversion"
htmlutil.cls line 261 "tp~queue(' 'htmlout~pversion)"

::ATTRIBUTE title
name of report
Definition at line 67 of htmlout.cls
Dynamically referenced by
htmlout.cls line 83 "self~title = title"
htmlout.cls line 109 "mh~queue('<title>'self~title 'Documents</title>')"
htmlutil.cls line 257 "tp~queue('Generated on' date() time() 'for' htmlout~title 'by')"
rexxliterate.cls line 164 "self~title = config~title"
rexxliterate.rex line 103 "config~title = title"
test.rex line 103 "config~title = title"

::ATTRIBUTE prefixcomment
remove from comment prefix
Definition at line 68 of htmlout.cls
Dynamically referenced by
htmlout.cls line 84 "self~prefixcomment = prefixcomment"
htmlout.cls line 230 "if self~prefixcomment = .nil"
htmlout.cls line 234 "if bc~text[j] <> self~prefixcomment[j]"
rexxliterate.cls line 167 "self~prefixcomment = config~prefixcomment"
rexxliterate.rex line 105 "config~prefixcomment = pf"
test.rex line 105 "config~prefixcomment = pf"

::ATTRIBUTE trailericon
tag to add to to left of trailer pages
Definition at line 69 of htmlout.cls
Dynamically referenced by
htmlout.cls line 85 "self~trailericon = trailericon"
htmlutil.cls line 252 "tp~queue(htmlout~trailericon)"
rexxliterate.cls line 166 "self~trailericon = config~trailericon"
rexxliterate.rex line 106 "config~trailericon = '<a href="http://sourceforge.net/projects/rexxliterate"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=266417&amp;type=10" width="80" height="15" alt="Get RexxLiterate at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>'"
test.rex line 106 "config~trailericon = '<a href="http://sourceforge.net/projects/rexxliterate"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=266417&amp;type=10" width="80" height="15" alt="Get RexxLiterate at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>'"

::ATTRIBUTE topmenu
top menu structure
Definition at line 70 of htmlout.cls
Dynamically referenced by
htmlindex.cls line 412 ".htmlutil~tabshead(hdr, htmlout~topmenu, pet)"
htmlout.cls line 86 "self~topmenu = .queue~new"
htmlout.cls line 91 "self~topmenu~queue(.array~of('main', 'main.html', 'petmain'))"
htmlout.cls line 93 "self~topmenu~queue(.array~of('documents', 'documents.html', 'petdocuments'))"
htmlout.cls line 94 "self~topmenu~queue(.array~of('programs', 'programs.html', 'petprograms'))"
htmlout.cls line 95 "self~topmenu~queue(.array~of('classes', 'classes.html', 'petclasses'))"
htmlout.cls line 96 "self~topmenu~queue(.array~of('methods', 'methods.html', 'petmethods'))"
htmlout.cls line 97 "self~topmenu~queue(.array~of('attributes', 'attributes.html', 'petattributes'))"
htmlout.cls line 98 "self~topmenu~queue(.array~of('procedures', 'procedures.html', 'petprocedures'))"
htmlout.cls line 99 "self~topmenu~queue(.array~of('routines', 'routines.html', 'petroutines'))"
htmlout.cls line 100 "self~topmenu~queue(.array~of('constants', 'constants.html', 'petconstant'))"
htmlout.cls line 101 "self~topmenu~queue(.array~of('options', 'options.html', 'petoptions'))"
htmlout.cls line 102 "self~topmenu~queue(.array~of('text', 'text.html', 'pettext'))"
htmlout.cls line 103 "self~topmenu~queue(.array~of('files', 'files.html', 'petfiles'))"
htmlout.cls line 114 "self~tabshead(mh, self~topmenu, 'petdocuments')"
htmlout.cls line 141 "self~tabshead(mh, self~topmenu, 'petdocuments')"
htmlout.cls line 170 "self~tabshead(mh, self~topmenu, 'petmain')"
htmlrexxclass.cls line 75 ".htmlutil~tabshead(tp, htmlout~topmenu, 'petclasses')"
htmlrexxprogram.cls line 81 ".htmlutil~tabshead(tp, htmlout~topmenu, 'petprograms')"
htmlrexxsource.cls line 82 ".htmlutil~tabshead(tp, self~htmlout~topmenu, 'petfiles')"
htmltext.cls line 74 ".htmlutil~tabshead(tp, htmlout~topmenu, 'petfiles')"

::ATTRIBUTE rexxliterate
owner rexxliterate
Definition at line 71 of htmlout.cls
Dynamically referenced by
htmlout.cls line 80 "self~rexxliterate = rexxliterate"
htmlrexxclass.cls line 275 "rdc = self~htmlout~rexxliterate~globalix~classix~at(supername~translate)"
htmlrexxclass.cls line 294 "rdc = self~htmlout~rexxliterate~globalix~classix~at(mixname~translate)"

::ATTRIBUTE pwrongdoc
queue of messages describing parameter docs not matching code
Definition at line 72 of htmlout.cls
Dynamically referenced by
htmlout.cls line 89 "self~pwrongdoc = .queue~new"
htmlutil.cls line 126 "htmlout~pwrongdoc~queue(m~document~relpath'::'m~ownerclass~rexxname'::'m~rexxname ''''pname'''')"
htmlutil.cls line 127 "else htmlout~pwrongdoc~queue(m~document~relpath'::'m~rexxname ''''pname'''')"
rexxliterate.cls line 240 "if self~htmlout~pwrongdoc~items > 0"
rexxliterate.cls line 243 "do i over self~htmlout~pwrongdoc"

::ATTRIBUTE pmissingdoc
queue of messages describing parameters with no docs
Definition at line 73 of htmlout.cls
Dynamically referenced by
htmlout.cls line 88 "self~pmissingdoc = .queue~new"
htmlutil.cls line 135 "htmlout~pmissingdoc~queue(m~document~relpath'::'m~ownerclass~rexxname'::'m~rexxname ''''pname'''')"
htmlutil.cls line 136 "else htmlout~pmissingdoc~queue(m~document~relpath'::'m~rexxname ''''pname'''')"
rexxliterate.cls line 247 "if self~htmlout~pmissingdoc~items > 0"
rexxliterate.cls line 250 "do i over self~htmlout~pmissingdoc"

::METHOD init


Parameters
rexxliterate not documented
hdest not documented
pversion not documented
title not documented
prefixcomment not documented
trailericon not documented
Definition at line 77 of htmlout.cls

::METHOD modules
Parameters
modules not documented
Definition at line 105 of htmlout.cls
Dynamically referenced by
htmlout.cls line 92 "if rexxliterate~modules~items > 0"
rexxliterate.cls line 230 "self~htmlout~modules(self~modules)"

::METHOD modpage
write modules page
Parameters
module not documented
Definition at line 132 of htmlout.cls
Dynamically referenced by
htmlout.cls line 123 "self~modpage(o)"

::METHOD repcode PRIVATE
write modules page
Parameters
text not documented
Definition at line 152 of htmlout.cls
Dynamically referenced by
htmlout.cls line 145 "mh~queue(self~repcode(i))"

::METHOD firstpage
Parameters
docs not documented
treeframe not documented
Definition at line 161 of htmlout.cls
Dynamically referenced by
rexxliterate.cls line 228 "self~htmlout~firstpage(self~rexxdocs, treeframe)"

::METHOD rhtmlpage
emit html pages for rexx program
Parameters
folder - the folder object for the rexx program
file - the file object for the rexx program
globalix - global index
Definition at line 210 of htmlout.cls
Dynamically referenced by
rexxliterate.cls line 397 "self~htmlout~rhtmlpage(f, i, self~globalix)"

::METHOD thtmlpage
emit html page for text file
Parameters
folder - the folder object for the text file
file - the file object for the text file
Definition at line 220 of htmlout.cls
Dynamically referenced by
rexxliterate.cls line 402 "self~htmlout~thtmlpage(f, i)"

::METHOD noprefix
remove prefix from block comment
Parameters
bc - a block comment
Returns
block comment with prefix removed
Definition at line 228 of htmlout.cls
Dynamically referenced by
htmlrexxclass.cls line 82 "blocko = self~htmlout~noprefix(rdc~document~getprevblock(rdc~feature))"
htmlrexxprogram.cls line 127 "blocko = htmlout~noprefix(file~document~getfirstblock)"
htmlrexxprogram.cls line 234 "blocko = htmlout~noprefix(file~document~getprevblock(i~feature))"

::METHOD tabshead
add a tabs header to a queue
Parameters
outq - the queue to which to add tabs
tablist - queue of three-element queues element 1 : display name of tab element 2 : url to associate with tab element 3 : selector name
selector - tab selector to set active
Definition at line 257 of htmlout.cls
Dynamically referenced by
htmlout.cls line 114 "self~tabshead(mh, self~topmenu, 'petdocuments')"
htmlout.cls line 141 "self~tabshead(mh, self~topmenu, 'petdocuments')"
htmlout.cls line 170 "self~tabshead(mh, self~topmenu, 'petmain')"


Get RexxLiterate at SourceForge.net. Fast, secure and Free Open Source software downloads
Generated on 31 Aug 2010 05:20:25 for RexxLiterate by rexxliterate  0.0.1