Difference between revisions of "Integration IDL reference - Visual .NET"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
m
Line 7: Line 7:
 
To use the API in a concrete development environment it would be preferable to access this documentation out of the prefered development environment of the developer. Currently the created documentation includes an index that provides access to it by the rules of Java documentation. That allows for example [http://www.netbeans.org/ NetBeans] users to acces the [http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html API IDL reference] directly from within that IDE via context-sensitive help etc.
 
To use the API in a concrete development environment it would be preferable to access this documentation out of the prefered development environment of the developer. Currently the created documentation includes an index that provides access to it by the rules of Java documentation. That allows for example [http://www.netbeans.org/ NetBeans] users to acces the [http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html API IDL reference] directly from within that IDE via context-sensitive help etc.
  
For the C++ development environment "Visual .NET IDE" such an integration would be nice to have as well. Though that is no open source product, it is used by many developers, some of those want to develop with the OOo API.
+
For the C++ development environment "Visual .NET IDE" such an integration would be nice to have as well. Though that is no open source product, it is used by quite many developers who may want to develop with the OOo API as well.
  
 
=== Task ===
 
=== Task ===

Revision as of 16:01, 26 October 2006

This is a possibility to contribute code to the OpenOffice.org (OOo) project in a manageable, limited area without the need to understand the deep mysteries of office code previously. ;-) May be interesting as a starter for people who have the skills to contribute code but are rather new to OOo.

Background

The OpenOffice.org API has a reference documentation of all the provided UNO interfaces, structs etc. The reference documentation is created by the tool Autodoc.

To use the API in a concrete development environment it would be preferable to access this documentation out of the prefered development environment of the developer. Currently the created documentation includes an index that provides access to it by the rules of Java documentation. That allows for example NetBeans users to acces the API IDL reference directly from within that IDE via context-sensitive help etc.

For the C++ development environment "Visual .NET IDE" such an integration would be nice to have as well. Though that is no open source product, it is used by quite many developers who may want to develop with the OOo API as well.

Task

Integrating Autodoc generated IDL documentation into the Visual .NET IDE.

To do this, the generated documentation needs to be expanded by some files that match the MS Help 2.0 format (see http://www.helpware.net/mshelp2/h20.htm for information). The data are provided by the Autodoc repository, that means one works within the code of the autodoc module of the OOo CVS, using also the cosv library.

Also the mechanism to compile the generated files and make the documentation visible within the Visual .NET IDE needs to be documented.

Needed

  • proficiency in C++ and object oriented programming,
  • curiosity about (or experience in) the framework of contributing to the OOo project,
  • helpful might be some knowledge about the OpenOffice.org SDK, UNO or IDL.

Contact

  • dev at tools dot openoffice dot org
  • Nikolai
Personal tools