Difference between revisions of "DSDP/MTJ/Developer Resources/Developer guide"

Revision as of 14:19, 23 January 2009

How to add things to the Developer Guide doc

Adding new plug-ins

To add new plug-ins you need to make changes in several places in the org.eclipse.mtj.doc.isv plug-in:

1. mtjOptions.txt
   • the plug-in source folder(s) must be included on the -sourcepath
   • code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and <plugin>/@dot for JARed plug-ins
   • the API package names must be included in the (alphabetical) package list at the end of the file
2. buildDoc.xml
   • If a plug-in contributes extension points, it should be added to the list of plug-ins in the <convertSchemaToHTML> task in the buildDoc.xml of the corresponding documentation plug-in.
3. plugin.xml
   • If your plugin has javadoc API, add a line to plugin.xml under the org.eclipse.pde.core.javadoc extension to associate your plug-in javadoc with the reference section for this doc plugin.

Adding new API packages

1. package.html
   • Create a package.html file for your API package, and place it in the package alongside the source code
2. tocreference.xml
   • add a line for each API package
3. hrml/reference/misc/overview-mtj.html
   • add the API packages to the corresponding section
4. platformOptions.txt
   • the API package names must be included in the (alphabetical) package list at the end of the file

Adding new extension points

1. html/reference/extension-points/index.html
   • add a line for each extension point
2. tocreference.xml
   • add a line for each extension point

based on How_to_add_things_to_the_Eclipse_doc