[Mono-docs-list] MonoDoc item schema

Joshua Tauberer tauberer@for.net
Tue, 17 Aug 2004 08:55:37 -0400

Francisco T. Martinez wrote:
> I did not create MS HTML Help 
> 1.1  *.chm files because the resulting HTML output did not have 
> traditional <html><head><title></title></head><body></body></html> 

Take a look at http://taubz.for.net/code/monodocs/corlib/en/html
That's how monodocs2html outputs things currently.  It has the usual 
HTML structure.

> Microsoft chose XML documents 
> for their "table of contents" and "index files".  So I not only need to 
> generate HTML output from the MonoDoc XML pages but must generate these 
> supporting files as well.

Monodocer creates an "index.xml" file in the root directory of 
documentation which monodocs2html uses to create the TOC (class listing) 
pages.  (Run monodocer with the --update command to generate the file 
for existing docs, since there aren't any index.xml files checked-in in 
CVS.)  You could transform these index files to TOCs and indexes using 
stylesheets.  (See the stylesheets in monodoc/tools.)

> Can you point me where to find the ECMA DTD?

I don't know if there was one (I think someone may have created an 
unofficial one at some point), but our docs have had a bunch of format 
changes since the original format, so I wouldn't follow an ECMA DTD.

> Once more let me congratulate you on the work you have done on 
> monodoc/tools.

Thanks.  :)

- Joshua Tauberer


** Nothing Unreal Exists **