Mark, Rick...

I like the idea of have three main "extensions" manuals
winextensions.pdf
unixextensions.pdf
rexxextensions.pdf

and would like to suggest that some extensions like rxftp and the new 
XML probably do fit in their own document, but would recommend that they 
be cross-referenced in the "main three" as appropiate.

This way, if you have a mental lapse, you can go to one spot to 
determine where something is really documented.

and on that note, is there a way to automatically create a single 
cross-reference document that could list the Classes and Method names
and simply tell you where it is documented? An index that identified  
"Book" or maybe "Book and chapter" or better yet "Book and Page"

/s/ Bill Turner, wb4alm



> We sort of have a hodgepodge at the moment.  rxrexexp is documented as
> a utility class in the ooRexx reference, while rxftp is documented in
> a separate document.  The XML support documentation will be fairly
> large, so I'm not sure it should be placed there.  I'm also not really
> that comfortable with creating a new document for each library.  This
> might be a good time to consider reorganizing things again.

We have already started towards this, maybe we just need to formalize it a bit.

Several releases ago, I pulled most of the doc for the smaller Windows
only extensions into winextensions.pdf.  Then David started
unixextensions for Unix specific extensions.  And we have
rexxextensions.pdf for platform independent extensions.  These make a
good separation in my mind.

rexxextensions.pdf currently has the doc for CVSStream and HostEMU.
It seems to me that rxmath, regexp, rxftp, and rxsock documentation
could all be moved into rexxextensions.

As for a separate doc for each library, I think that depends on the
extension.  If the size of the doc for an extension by itself is 4 or
5 MB, than I think that justifies a separate doc.  On the other hand,
a size like 275 KB, like rxmath, would indicate it was a good
candidate to be merged into one of the other docs.



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Oorexx-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/oorexx-devel

Reply via email to