Hi Tom,
currently autodoc generates the reference from the IDL files.
But you can get all the info from the type library as well. In the build env we have two type libraries, one with docu and old style services and one without.
The best way would be to have the docu as xml snippets (directly in IDL or at least in the type library converted by idlc). A docu generation process converts the type library in a complete xml representation. All other docu production steps would be on top of this xml stuff.
We have had the idea in the past to have a small tool which generates the docu on the fly when docu is requested (using a XSL transformation). But we never have found the time to investigate deeper in this idea. The idea was to analyze the way where you come from, means analyze the context and display context dependent docu only. For example a generic interface (e.g. special container) in the context of a text document can provide other docu as the same interface in the context of an impress document.
It would make perfect sense to integrate such an engine (working on the type library only) in the online help of OO where the reference docu is still missing.
- Juergen
Thomas Schindl wrote:
Hi,
How is the IDL created? Maybe we could switch to output format to XML and
then do the same the codesnippet page does? XML => HTML * once sorted alphabetically * once grouped like it is now
According to the what the user desires? We could even create other output formats from this point on e.g. PDF, ... .
I just needed to know how to create the IDL-page-creation is done at the moment (hopefully some template mechanism) ;-)
Tom
Hi Tom,
I suppose that the IDL-Reference Properties are ordered at the moment using the occurrence of the properties in the IDL-File. The good point about this is that you can group together things like RightMargin and LeftMargin but for someone who is looking for a property it would be much more useful to have the properties sorted alphabetically.
What do the others think about it?
Nobody seems to have an opionion about it. Ok, my opinion is also not helpful. Either way can be useful. Grouping logically (meaning like in the IDL file) or alphabetically both have their advantages. I don't know what's better.
Ideally we would have a dynamic online reference manual where you can select both orders and the sorting is done as you choose. Any volunteers? ;-)
Michael
-- Michael Hoennig <[EMAIL PROTECTED]> project lead OpenOffice.org API http://api.openoffice.org
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
