I like the idea of putting the documentation generation package into the
"tools" directory on SVN. I was wondering how/where to put it since the
Publican tools are on the site but in the files/windows-build-tools/
section. When Version 2 is ready (soon), we can discuss the best way to
store them (individual files, a zipped folder, etc.). Thanks for setting
this up!
Gil
On 3/10/2020 9:24 AM, Rick McGuire wrote:
On Tue, Mar 10, 2020 at 9:12 AM Rony G. Flatscher
<rony.flatsc...@wu.ac.at <mailto:rony.flatsc...@wu.ac.at>> wrote:
Thank you for your feedback, Rick. As a result the current rexxpg
book at
<https://www.dropbox.com/sh/gxvvgskb04gdsqf/AACRo_ZLeFOdoBXUHroPY_-Ca?dl=0>
<https://www.dropbox.com/sh/gxvvgskb04gdsqf/AACRo_ZLeFOdoBXUHroPY_-Ca?dl=0>
reflects the changed hierarchy tree (created from a script).
There would be two questions still:
* the original book documents the "RegularExpression" (4.1.26)
class, but it is not available by default, therefore I would
leave it out, if that is o.k.,
Yes, that is ok, but it might also be nice to have a section that
lists classes that come from packages included with the interpreter
(and how to get them).
*
* there is a subchapter "4.1.7 Collection Classes" which lists
all collection classes; this goes back to the previous listing
of the classes which was not correct. As the rexxref book
explains the collection classes I would plan to reorder the
brief description of the classes by alphabet only (e.g. also
correcting the position of the "NumericComparator" and
"Orderable" classes etc.) in section 4.1
I think the classes should be organized first by category (i.e., All
the Orderable classes together, all of the MapCollections together).
Comparators should also be their own section.
*
Would that be o.k. with everybody?
---
Another question: I wrote a little Rexx script to create the class
hierarchy and optionally create the Docbook XML rendering that can
be directly copied into the "provide.xml" chapter of the rexxpg book.
How about creating a "tools" directory in "doc/trunk" and place
the script there, such that everybody can use it, should an update
of the class hierarchy become necessary in the future?
Excellent idea. When you first posted that there were bits that
appeared to be automatically generated, I was surprised when didn't
appear to have the tool that generated these under source control. I
suspect Gil's tooling should also be placed there. Not sure how to
handle the binaries needed to generate the pubs, though I suspect
having them in the svn repo might be a good idea too.
Also, if o.k. with everybody, then I would suggest to place all
book related utilities in that directory, each with a brief readme
section at the top explaining what the script is meant for and
supposed to do.
---rony
_______________________________________________
Oorexx-devel mailing list
Oorexx-devel@lists.sourceforge.net
<mailto:Oorexx-devel@lists.sourceforge.net>
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
_______________________________________________
Oorexx-devel mailing list
Oorexx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
--
Gil Barmwater
_______________________________________________
Oorexx-devel mailing list
Oorexx-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/oorexx-devel
