MyHelp class>>topicAboutWritingHelpTopicInGeekyWay
^ self topicTitle: 'How to write help in geeky way' contents:
'There''s nothing special, since help system expects string to be
returned, which is then converted to text
and shown to user.. And who said that this method should contain the
same text which you displaying?
Sometimes, when you have some list of rules, which sits in a single
class (like list of default options
with short description for each of them, you can, of course copy and
paste the list, format it more appropriate for reader
and voila.. you got your page.. But downside of copying is that you
will have to maintain two copies of same thing and have to sync
them for the rest of your life. So, here a geeky way to avoid
duplication effort: ' ,
self extractCommentsFromCode: ( MyClass >> #myMethodWhereIPutOptions )
,
' and of course, i can continue here putting some more text, if
needed.. but i think i made it clear already how you can
make your help system to stay more up to date when you updating the code ;)'
------
This is Spar... err smalltalk! :)
--
Best regards,
Igor Stasenko.
