Am Dienstag, 2. März 2010 21:36:07 schrieb Stéphane Ducasse: > Hi danny > > I would like to integrate your help system in pharo so we will have see how > we can proceed. I would like to add it in a modular way. Does anybody has > a nice idea? Now I would really like to see how we can produce some help > automatically like by tagging and commenting some cool SUnit tests. > At least we should have it in pharo-dev. > > Stef > _______________________________________________ > Pharo-project mailing list > [email protected] > http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project >
Hi! Do you mean ProfStefBrowser (frontend fo ProfStef) or HelpSystem (initially started by Torsten)? I am not sure what you mean by modular. It has a Metacello configuration. With regard to automatic help, in HelpSystem API help on packages and individual classes can already be generated automatically, and some very basic support for tagging methods is implemented. Right now it generates a page with documentation for all methods in a class, with methods tagged with <help> reordered to appear at the top of the text. A nice idea on squeak-dev was to add support for a simple structured markup language like Markdown in class comments. We could use this to write "big- picture" documentation directly in a class comment. I think this would complement the method comments quite nicely. Danny _______________________________________________ Pharo-project mailing list [email protected] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
