Hi, Nice idea, I like the "wiki help description" for three reasons:
- its pragma based AND allows for definition of structured books
(so Lukas should be satisfied since he can define content
without dependency on help system)
- it allows us to reuse existing swiki contents
(if the full syntax is supported we can query existing
swikis!)
So it is a nice idea and would be a good addition.
I reworked Alains code to better fit the pluggable architecture
of the HelpSystem framework (now using a builder):
Use an updated 1.2 core image, code is attached
1. File in "Foo.st" (which defines a simple help description)
=> no dependency on any help system
2. First I added a registration mechanism (pragma <systemHelp>
so one can add own help types to the system help
(the one that appears when you open the default help browser)
=> load "AddToSystemHelpFix.1.cs"
=> at least this fix should go into Core 1.2, so
no ugly hacks are necessary to appear in the
default help browser
I added a now fixed issue for core 1.2 on:
http://code.google.com/p/pharo/issues/detail?id=3511
3. I reworked Alains code so it uses a WikiStyleHelpBuilder
(similar to the other builders) and a WikiStyleHelp as
a new help type
=> see WikiStyleHelp.5.cs
=> if we agree on this we can integrated it into core too,
currently it is in an own class category/package
=> "HelpBrowser openOn: WikiStyleHelp"
will show all contents defined using the wiki style syntax,
so only the one defined in class Foo appears
=> "HelpBrowser open"
will show all help in the system (including the ones
defined in Foo)
=> since it uses the new registration mechanism (see 2. above)
all these topics will also appear in the help browser
that is accessible from the menu
I would vote for adding this to core 1.2 too. It's additional,
nothing should break. What do you all think...
And thanks Alain for the idea and initial code!!!
Have fun
T.
--
Neu: GMX De-Mail - Einfach wie E-Mail, sicher wie ein Brief!
Jetzt De-Mail-Adresse reservieren: http://portal.gmx.net/de/go/demail
AddToSystemHelpFix.1.cs
Description: Binary data
WikiStyleHelp.5.cs
Description: Binary data
Foo.st
Description: Binary data
