Torsten,<div><br></div><div>Thanks for putting me onto this, it's way cool, and you have saved me from trying to implement it myself. </div><div><br></div><div>I wanted to point out, ascii (or maybe unicode) is fine. If we want markup, I think the way to do that would be to implement something like #asWAComponent on HelpTopic and let Seaside do the heavy lifting.</div>
<div><br></div><div>Anyhow, way cool!<br><br><div class="gmail_quote">On Tue, Apr 20, 2010 at 11:31 AM, Torsten Bergmann <span dir="ltr"><<a href="mailto:astares@gmx.de">astares@gmx.de</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
Hi,<br>
<br>
sorry for changing the topic - but again I saw discussion on<br>
"in-image" documentation.<br>
<br>
Are you all aware of the "HelpSystem" project that I wrote for Pharo and<br>
Squeak and that was already discussed on pharo-dev list.<br>
<br>
It is ready for integration and we can already fill it with<br>
content packages (docus, lessons as books). It is still ASCII based<br>
but maybe we can later enhance it using old Scamper code to be based<br>
on simple markup, ...<br>
<br>
If you want to have a look at the "core":<br>
<br>
Installer squeaksource<br>
project: 'HelpSystem';<br>
install: 'HelpSystem-Core'.<br>
<br>
This "core" has the basic support and the browser. But you can<br>
write your documentation content even without it and later<br>
convert it using a special method. More on this below.<br>
<br>
You can open the help browser via "open" -> "HelpBrowser" or by evaluating<br>
"HelpBrowser open". By default it only provides the help for the help<br>
system itself.<br>
<br>
If you load it with example books like<br>
<br>
Installer squeaksource<br>
project: 'HelpSystem';<br>
install: 'HelpSystem-Core';<br>
install: 'HelpSystem-Tests';<br>
install: 'Metacello-Help';<br>
install: 'Pharo-Project-Help';<br>
install: 'Squeak-Project-Help'.<br>
HelpBrowser open<br>
<br>
<br>
from the same repository you will get examples how books can<br>
look like.<br>
<br>
It also integrates an API Help like system, try one of these:<br>
<br>
HelpBrowser openOn: Integer.<br>
HelpBrowser openOn: (SystemReference hierarchyFor: Integer).<br>
HelpBrowser openOn: SystemReference. "Complete reference"<br>
<br>
Gives contents without much work ;)<br>
<br>
The basic model is simple now (see [1] and class HelpTopic and<br>
HelpBrowser). Read [2] and [3] and the "Help on Help" book in<br>
the help browser itself to learn about it.<br>
<br>
If you want to write own books that show up in the standard<br>
SystemHelp look at subclasses of CustomHelp.<br>
<br>
But you can open the help browser on anything that implements<br>
#asHelpTopic. Check for implementors to learn from the code.<br>
<br>
So either you create a book in the CustomHelp class hierarchy<br>
or define your content elsewhere.<br>
<br>
You can easily convert any source into a help topic, which I<br>
demoed with the IRC channel logs.<br>
Evaluate my code example in [4] to get a help browser on last<br>
weeks activity on squeak IRC channel.<br>
<br>
See also the attached screenshots.<br>
<br>
Bye<br>
Torsten<br>
<font color="#888888">--<br>
GRATIS für alle GMX-Mitglieder: Die maxdome Movie-FLAT!<br>
Jetzt freischalten unter <a href="http://portal.gmx.net/de/go/maxdome01" target="_blank">http://portal.gmx.net/de/go/maxdome01</a><br>
<br>
</font></blockquote></div><br></div>