[Mono-docs-list] Documentation Import format?

[Jonathan Pryor]

On Fri, 2007-06-29 at 00:57 -0400, Timothy Davis wrote:
> My app is a Mono Type Reflector for OS X, (GUI Screenshot
> -> http://www.binarymethod.com/images/typereflex.png (not complete
> yet)) and I was wondering if there was a predetermined file format
> that I could export so that the user could upload it to the offical
> Mono docs?  That way you could work on stuff offline and then online
> it later.

Yes, it's an XML dialect.  See:

http://www.mono-project.com/Monodocer
http://anonsvn.mono-project.com/source/trunk/monodoc/man/monodocer.1
http://anonsvn.mono-project.com/source/trunk/monodoc/tools/DocTest/en.expected/Mono.DocTest.Generic/MyList%602.xml

(The latter is an example XML file.  Real XML files are stored on
monodoc/class/ASSEMBLY-NAME/en/NAMESPACE/CLASS.xml.)

> I see that when I goto the online docs page that it says users can
> edit and then upload...but I have yet to find an edit link or upload
> link.  Am I  missing something?

You can edit and upload through the monodoc browser/editor.  Uploading
uses a SOAP service and its own custom dialect (which I'm not familiar
with); using the monodoc XML format (above) is what's stored in svn.

 - Jon

>