Issue 3522 in pharo: wiki like help contents

Status: Accepted
Owner: aplantec
CC: [hidden email]
Labels: Milestone-1.2

New issue 3522 by aplantec: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

The help system will provide a way to integrate contents with wiki markup.

Updates:
        Labels: -Milestone-1.2 Milestone-1.3

Comment #1 on issue 3522 by marcus.denker: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

not 1.2

Comment #2 on issue 3522 by stephane.ducasse: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

If you have some cycles I would like to integrate a version in 1.2 because  
having a good help is important.

Comment #3 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

I'm waiting for feeback on the

  <wikiStyleHelp:syntax:>

idea

Comment #4 on issue 3522 by aplantec: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

Sorry Torsten...I'm doing too much things in parallel
Your proposition to have
<wikiStyleHelp:syntax:> and <wikiStyleHelp:> as default for pier syntax is  
ok for me.
And its cool because my setting browser comments are ready for this :)

Comment #5 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

So we take this changeset (which is the same as from my post on  
http://lists.gforge.inria.fr/pipermail/pharo-project/2011-January/039166.html)
and start from it to extend it with the "double pragma".





Attachments:
        WikiStyleHelp.5.cs  3.7 KB

Comment #6 on issue 3522 by aplantec: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

Take my WikiStyleHelpBuilder (.st attached).
The only change concerns the section start char which is $! instead of $=  
in your .cs

Attachments:
        WikiStyleHelpBuilder.st  3.5 KB

Comment #7 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

Attached is the new code WikiStyleHelp.6.cs wich allows to use two pragmas:

<wikiStyleHelp:>         AND
<wikiStyleHelp:syntax:>

First one is only a shortcut for <wikiStyleHelp: 'blah' syntax: #pier> since
#pier is the default syntax (and the only one that is
currently supported here).

Feel free to work on WikiStyleHelpBuilder to support other syntaxes
if required (maybe the help builder should delegate to syntax helper
classes or the like).


Also attached is a Foo.st example with two annotated methods that
demonstrates the use of the pragmas. You can load Foo.st first, since
it is pragma based AND DOEST NOT DEPEND on help system in any way.




Attachments:
        Foo.st  911 bytes
        WikiStyleHelp.6.cs  6.5 KB

Updates:
        Cc: stephane.ducasse

Comment #8 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

(No comment was entered for this change.)

Comment #9 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

SLICE-Issue-3522-wiki-like-help-contents in InBox
Thanks a lot Torsten, I let you test it and tag this issue as fixed if its  
ok.

Updates:
        Labels: -Milestone-1.3 Milestone-1.2

Comment #10 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

I want that in 1.2 :)
so in the next integration

Updates:
        Status: Fixed

Comment #11 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

Short test, looked OK for me. We can tag this as fixed
and Stef is able to write the documentation for Soup
with pragma and without any dependency on HelpSystem itself:

    docuForSoup
        <wikiStyleHelp: #'Soup framework'>
        ^'! Introduction
!! First Page
Soup is ...

'

Updates:
        Status: Closed

Comment #12 on issue 3522 by [hidden email]: wiki like help contents
http://code.google.com/p/pharo/issues/detail?id=3522

(No comment was entered for this change.)