On Mar 4, 2010, at 8:48 PM, Danny Chan wrote:
>>
>>> I am not sure what you mean by modular. It has a Metacello configuration.
>>
>> my point is if you imagine that we want a small system with good packages
>> where do we put the helpSystem.
> Hm, still not 100% sure what you mean. If you're asking how we can have
> documentation usable with HelpSystem without having to actually load
> HelpSystem, then see below.
I was thinking aloud.
I was thinking
we can load HelpSystem and use it but since we want to have core
we should get it in Pharo but still make sure that everything in Core is
adapted to give info
to Pharo.
>>> A nice idea on squeak-dev was to add support for a simple structured
>>> markup language like Markdown in class comments. We could use this to
>>> write "big- picture" documentation directly in a class comment. I think
>>> this would complement the method comments quite nicely.
>>
>> Do you have an example?
>>
>
> In a package you put in the most important class a comment that looks somehow
> like this:
>
> <classcomment>
> Here comes the comment for the class
> </classcomment>
Why XML?
> <packagecomment>
> This is the documentation for MyPackage.
>
> # Introduction
> A bit of introduction.
> # Another chapter
> More text.
> ## Structure
> You can have sub levels
>
>
where do you define
<packagecomment>
> And this would create a documentation tree like this (text after the colon is
> displayed in the content window):
>
> - MyPackage: This is the documentation for MyPackage.
> - Introduction: A bit of introduction
> - Another chapter: More text
> - Structure: You can have sub levels
> - API documentation
> - Class1 documentation
> - Instance Methods
> - Class Methods
> - Class1 documentation
> - Instance Methods
> - Class Methods
> ...
>
> Now you have all the documentation for a package in the comments, but you can
> view it in a nicely structured way.
>
> Does this make sense?
Yes
In addition I would like to have a tag for promoting test to be list in the
help.
<documentation>
Would be nice.
Stef
>
> Danny
>
> _______________________________________________
> Pharo-project mailing list
> [email protected]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
_______________________________________________
Pharo-project mailing list
[email protected]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
