Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "How to add things to the Eclipse doc"
m (→Adding new plugins: pre-built plug-ins) |
|||
Line 2: | Line 2: | ||
− | == Adding new plugins == | + | == Adding new plugins == |
− | To add new plug-ins you need to make changes in several places in the org.eclipse.platform.doc.isv plug-in: | + | To add new plug-ins you need to make changes in several places in the org.eclipse.platform.doc.isv plug-in: |
+ | |||
+ | #platformOptions.txt | ||
+ | #*the plug-in's source folder(s) must be included on the -sourcepath | ||
+ | #*code of required plug-ins must be added on the -classpath | ||
+ | #** non-JARed plug-ins: Path(s) to the JAR(s) | ||
+ | #** JARed plug-ins: <plugin>/@dot | ||
+ | #** plug-ins not built during the platform build: Name of the built JAR ('''Caveat:''' remember to update the version in the reference when a new version is used) | ||
+ | #*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's Javadoc with the reference section for this doc plug-in. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Adding new API packages == | == Adding new API packages == | ||
Revision as of 01:43, 17 February 2010
Last revised May 15, 2006
Adding new plugins
To add new plug-ins you need to make changes in several places in the org.eclipse.platform.doc.isv plug-in:
- platformOptions.txt
- the plug-in's source folder(s) must be included on the -sourcepath
- code of required plug-ins must be added on the -classpath
- non-JARed plug-ins: Path(s) to the JAR(s)
- JARed plug-ins: <plugin>/@dot
- plug-ins not built during the platform build: Name of the built JAR (Caveat: remember to update the version in the reference when a new version is used)
- 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's Javadoc with the reference section for this doc plug-in.
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
- topics_Reference.xml
- add a line for each API package
- reference/misc/overview-platform.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
- reference/extension-points/index.html
- add a line for each extension point
- topics_Reference.xml
- add a line for each extension point
Back to Eclipse Documentation