[Pharo-project] wiki style help

Tudor Girba tudor.girba at gmail.com
Fri Jan 7 01:40:58 EST 2011


Nice.

Doru


On 7 Jan 2011, at 07:33, Alain Plantec wrote:

> I've changed the section start character from $= to $! as in Pier.
> Now, such a help text can be compatible with the pier parser.
> Cheers
> Alain
> 
> Le 07/01/2011 00:08, Alain Plantec a écrit :
>> Le 06/01/2011 23:55, Tudor Girba a écrit :
>>> That's cool, but why not use the Pier model/parser?
>> not against  except that it would depend on other packages.
>> it implies that it would not be possible for the core.
>> this implementation is only made of an additional class with 3 methods.
>> at least one could use the pier syntax for declaring sections
>> Cheers
>> Alain
>>> Cheers,
>>> Doru
>>> 
>>> 
>>> On 6 Jan 2011, at 23:33, Alain Plantec wrote:
>>> 
>>>> Hello!
>>>> I've prototyped a small addon for the help system.
>>>> It allows the using of formatted text "a la wiki"
>>>> for editing help pages.
>>>> help pages are retrieved thanks to a pragma.
>>>> In order to write an help, only 2 steps
>>>> 
>>>> * Step1: You edit you help as follow:
>>>> = Introduction
>>>> Your intro here
>>>> = Section 1
>>>> bla bla
>>>> == Section 1.1
>>>> blo blo blo
>>>> === Subsubsection 1.1.1
>>>> =Section 2
>>>> == Section 2.1
>>>> =Conclusion
>>>> 
>>>> * Step 2: then you implement a method with a pragma
>>>> that return the formatted string:
>>>> Here, the help is in the comment of the class.
>>>> 
>>>> SomeClass class>>help
>>>> <wikiStyleHelp: #'A wiki style help example'>
>>>>    ^ self comment
>>>> 
>>>> ... and you have your help (see screenshot)
>>>> 
>>>> You also can use only a subpart of a comment by using a tag.
>>>> <help>
>>>> you wiki style comments here
>>>> </help>
>>>> 
>>>> It is very simple and it allows the using of comments (less help duplication ?).
>>>> Concerning the builder approach, maybe we don't
>>>> need it because we can use text markup.
>>>> 
>>>> try it with HelpSystem-Core-AlainPlantec.69 in PharoTaskForces
>>>> It works.
>>>> not documented
>>>> no tests
>>>> 
>>>> Cheers
>>>> Alain
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> 
>>>> <wikiStyleHelp.png>
>>> -- 
>>> www.tudorgirba.com
>>> 
>>> "Speaking louder won't make the point worthier."
>>> 
>>> 
>> 
>> 
> 
> 

--
www.tudorgirba.com

"If you interrupt the barber while he is cutting your hair,
you will end up with a messy haircut."





More information about the Pharo-dev mailing list