[Mono-docs-list] MonoDoc item schema

Tue, 17 Aug 2004 06:45:28 -0500

Joshua Tauberer wrote:

Josh:

You make a lot of sense.  I mainly ran the genthtml and other scripts 
from cygwin in Win32.  The fact that I did generated some output means 
that I am close but not quite there yet.  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> 
structure to them.  This kept breaking the MS HTML Help compiler.  
However, the MS HTML HELP 2.0 tool kit was friendlier to the output I 
was generating.

I think everyone would love to have MonoDoc run on Win32, but that is 
not possible just yet.  In the meantime I have embarked on the adventure 
of creating MS HELP formats that can be used withing Visual Studio (a 
Microsoft IDE used to develop .NET in Windows).  This should afford the 
user a tree view structure for the table of contents as well as index 
and "full text" searching capabilities.   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.

As far as the schema (xsd file) is concern I can probably generate one 
from studying the XML item pages and/or convert a DTD.  The link you 
included in your reply is excellent.  I am sure I will be referring to 
it as I go further down the road.  Can you point me where to find the 
ECMA DTD?  If not, there may be a URL or some other reference embedded 
within the pages, but it would be great if you cant point me to it.

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

Paco

>Paco,
>
>No schema exists.  It wouldn't be too hard to create based on my description
>of the files at:
>    http://www.nullenvoid.com/mono/wiki/index.php/ECMAStyleDocumentation
>
>But, how much more control do you need over the HTML generation?
>Monodocs2html already lets you use a custom page template, and it would be
>fairly easy to allow other methods of customization, like changing the way
>links are handled.  It would be great if the existing tools could be
>extended to do what you need.
>
>Creating some nice XSLTs to convert monodoc docs to other formats would be
>good as well, though no one has had the patience for it yet.  :)  I keep
>saying it must not be difficult, but since no one's been able to finish it
>yet, maybe I underestimated the problem.
>
>Let me know if I can help in any of the above ways.
>
>- Josh
>
>
>----- Original Message -----
>From: "Francisco T. Martinez" <martinf@mfconsulting.com>
>To: <mono-docs-list@lists.ximian.com>
>Sent: Monday, August 16, 2004 9:44 AM
>Subject: [Mono-docs-list] MonoDoc item schema
>
>
>  
>
>>Hello:
>>
>>Does any one know if there is an XSD file that describes the complete
>>schema that may be used for MonoDoc documents (overviews, specific item
>>pages, etc.)
>>
>>I am building MS Help Files for Win32 and plan to do a lot of XSLT to
>>generate HTML versions of the existing XML formats.  I have taken a look
>>at the great work that was done in monodoc/tools but may need much more
>>finer degree of control over the HTML generation process.
>>
>>Of course if no one knows about the existence of such schema, I may
>>create my own and may publish or make accessible my documentation in the
>>documentation format generated by XML Spy (see the following link of a
>>sample based on the project file format used by MonoDevelop:
>>http://www.mfconsulting.com/product/prj2make-sharp/prjxDoc/index.html )
>>
>>Paco
>>
>>_______________________________________________
>>Mono-docs-list maillist  -  Mono-docs-list@lists.ximian.com
>>http://lists.ximian.com/mailman/listinfo/mono-docs-list
>>
>>    
>>
>
>
>_______________________________________________
>Mono-docs-list maillist  -  Mono-docs-list@lists.ximian.com
>http://lists.ximian.com/mailman/listinfo/mono-docs-list
>  
>