[squeak-dev] HelpSystem & Class comments

Ian Trudel ian.trudel at gmail.com
Wed Feb 24 13:27:27 UTC 2010

2010/2/24 Torsten Bergmann <astares at gmx.de>:
> However: the main question to me is the kind of format we should
>         use:
>  a) Wiki Style or similar
>      + easy to write
>      + easy to transform
>      - mostly non-standard
>     With Maven the APT format is often used [1], Eclipse for instance
>     provides even editors, see [2] for screenshots)
>     But we also have Tiny wiki syntax somewhere on SqueakSource which
>     may be similar.
>  b) real markup like HTML
>      + easy to put onto the web without tranformation
>      - we need to have more markup support
>      -/+ embedding of Smalltalk has to be done the W3C way, similar
>        to javascript  <a href="smalltalk:..."
>  c) specific format like Squeaks Text representation with textDoits, ...
>      - very Squeak specific and may not work in Pharo
>      - hard to put on the web

I would be in favour of an internal representation, whereas we could
use an UI editor with edition tools. The idea is to be able to use
different backends. The system could be used within Squeak environment
but also to generate online documentation.


More information about the Squeak-dev mailing list