Hi! I like the idea. On the weekend I hacked a bit of code to generate help pages from the class and methods comments. I have just added another bit of code that sorts the documentation for all methods so that methods with a <help> pragma appear in a special section. See the "Help on Help" pages in the browser.
And I just learned that you can load this with (ConfigurationOfHelpSystem project version: '1.0-baseline') load. Danny Am Sonntag, 21. Februar 2010 23:39:16 schrieb Stéphane Ducasse: > Torsten / Danny > > I was discussing with laurent and I like his idea. > We could tag > test with > <publichelp> > > and the tests would be used for the Help. We could design test that are > more for understanding than identifying bugs and we would have a win-win > situation: documentation and always in sync. > > doing the same for class comments would be nice. > Often in a package you have one or two important classes. > > This would be a good incentive to get cool comments. > > On Feb 19, 2010, at 5:00 PM, Torsten Bergmann wrote: > > Since we share tools and code - we may in the future also > > share (in-image) documentation for tools. What is new: > > > > - Refactored and updated the code > > - Help System is now usable in Pharo and Squeak too > > - Metacello config is updated for both > > - there is an initial help for the Pharo project and the Squeak project > > (depending on from where you load it) > > - the help for the help system is displayed as last book > > - I merged HelpContents into a new HelpPage - so we have books and > > pages (we may later add other forms than text in subclasses like > > HTMLHelpPage, ...) > > > > The help browser includs a book on how to provide/implement an own > > custom help. Future version may include specific colored icons for > > squeak and better UI depending on the UI system (Polymorph in Squeak) > > as well as authoring tools. > > > > Thanks to Metacello one is able to manage the differences. To load: > > > > Squeak > > ====== > > > > Installer ss project: 'MetacelloRepository'; > > install: 'ConfigurationOfHelpSystem'. > > > > ((Smalltalk at: #ConfigurationOfHelpSystem) project version: '1.0') > > load > > > > > > Pharo > > ===== > > > > Gofer new > > squeaksource: 'MetacelloRepository'; > > package: 'ConfigurationOfHelpSystem'; > > load. > > > > ((Smalltalk at: #ConfigurationOfHelpSystem) project version: '1.0') > > load > > > > > > Bye > > T. > > _______________________________________________ > Pharo-project mailing list > [email protected] > http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project > _______________________________________________ Pharo-project mailing list [email protected] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
