Re: Ruby Embedded Documentation

"Lyle Johnson" <[e-mail]> writes:

> Currently, it only has an HTML backend but I think Dave envisions
> other output formats as well.

Volunteers always welcome :)

Actually, to that end, I was thinking of making use of the mailing
list that sourceforge gives us. Would people be interested in
participating?

> And, given RDoc's alpha status, its own markup style will no doubt
> continue to evolve as more and more people start to use it and
> influence its design.

I very much hope to keep the markup stuff itself backward compatible.
Right now it's deliberately very simple, and I intend to keep it so
until we've added some backends and have worked out what the various
issues are likely to be. It would be easy at this stage to start
falling into the "everything is like HTML trap" and then make it
difficult when we first want to generate RTF or Postscript.

The next major change is likely to be internationalization: I've been
chatting with Jaf and Vruz about what might be required, and I hope to
be releasing some notes for people to comment on fairly soon. (This
isn't a change I want to make without feedback, as it's a subject I
know _nothing_ about).

Remember also that I intend to use the same markup engine for other
tools, so there's a lot of motivation to keep it clean (in fact
cleaner than it is right now - there are some smells in there).


Anyway, the moral here is that there will definitely be evolution in
the markup style, but stuff you do now will continue to work in the
future.

I hope.


Dave