Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "DSDP/MTJ/Developer Resources/Developer guide"
< DSDP | MTJ | Developer Resources
Line 1: | Line 1: | ||
− | + | == How to add things to the Developer Guide doc == | |
− | == Adding new plug-ins == | + | === 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: | To add new plug-ins you need to make changes in several places in the '''org.eclipse.mtj.doc.isv''' plug-in: | ||
Line 14: | Line 14: | ||
#* If your plugin has javadoc API, add a line to plugin.xml under the <code>org.eclipse.pde.core.javadoc</code> extension to associate your plug-in javadoc with the reference section for this doc plugin. | #* If your plugin has javadoc API, add a line to plugin.xml under the <code>org.eclipse.pde.core.javadoc</code> extension to associate your plug-in javadoc with the reference section for this doc plugin. | ||
− | == Adding new API packages == | + | === Adding new API packages === |
# '''package.html''' | # '''package.html''' | ||
Line 25: | Line 25: | ||
#* the API package names must be included in the (alphabetical) package list at the end of the file | #* the API package names must be included in the (alphabetical) package list at the end of the file | ||
− | == Adding new extension points == | + | === Adding new extension points === |
# '''html/reference/extension-points/index.html''' | # '''html/reference/extension-points/index.html''' |
Revision as of 14:19, 23 January 2009
Contents
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:
- 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
- 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.
- 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.
- If your plugin has javadoc API, add a line to plugin.xml under the
Adding new API packages
- package.html
- Create a package.html file for your API package, and place it in the package alongside the source code
- tocreference.xml
- add a line for each API package
- hrml/reference/misc/overview-mtj.html
- add the API packages to the corresponding section
- platformOptions.txt
- the API package names must be included in the (alphabetical) package list at the end of the file
Adding new extension points
- html/reference/extension-points/index.html
- add a line for each extension point
- tocreference.xml
- add a line for each extension point
based on How_to_add_things_to_the_Eclipse_doc