[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [sc-dev] [Comments?]XML doc? Fwd: html doc

On Thu, Feb 12, 2004 at 12:45:59AM -0800, James McCartney wrote:
> That would only handle the UGen classes. It is not very general to 
> handle other parts of the docs.

the problem is that implementing wysiwyg markup editing is
hard if there is no os/library support. the problem with rtf
markup in particular is that it's not easily parsable,
doesn't contain/preserve structural information, is layout
centric and in some cases the output depends on the font
used etc. -- i've yet to find an rtf editor on linux that
renders Help.help.rtf correctly.

is wysiwyg really a requirement? imho an html/xhtml
representation would be a viable alternative, if you can
switch between edit and view mode within the same document
interface or have proper tool support to convert to any
representation desired.

e.g. on linux i wouldn't mind viewing documentation in an
external browser application, if documents are properly
hyperlinked, or to convert into a text representation on the
fly for display and code execution in emacs.

on osx with its superior document apis (grrrr...) it should
be possible to edit a help file and change to browsing mode
by the flick of a switch.