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 "How to add things to the Eclipse doc"
m (corrected title layout, added path to overview-platform.html) |
(→Adding new API packages: package-info.java) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == 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 | ||
| + | #** remember to remove the plug-in from -classpath if it was already there | ||
| + | #*code of required plug-ins must be added on the -classpath (unless they are already on the -sourcepath) | ||
| + | #** non-JARed plug-ins: Path(s) to the JAR(s) | ||
| + | #** JARed plug-ins: <plugin>/@dot | ||
| + | #** plug-ins not built during the platform build: path to the built JAR<br>'''Caveat:''' the JAR name typically contains a version: | ||
| + | #*** Either remember to update the version in the reference whenever a new version is used | ||
| + | #*** Or (since 3.8 incl. maintenance branches) replace the <code>_<major>.<minor>.<service>.<qualifier></code> with <code>_*</code> if only one version of the JAR is present during the build. | ||
| + | #*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 == | ||
| + | # package.html | ||
| + | #* Create a package.html or package-info.java file for your API package, and place it in the package alongside the source code | ||
# topics_Reference.xml | # topics_Reference.xml | ||
#* add a line for each API package | #* add a line for each API package | ||
| − | |||
# reference/misc/overview-platform.html | # reference/misc/overview-platform.html | ||
#* add the API packages to the corresponding section | #* 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 == | == Adding new extension points == | ||
| Line 29: | Line 35: | ||
# topics_Reference.xml | # topics_Reference.xml | ||
#* add a line for each extension point | #* add a line for each extension point | ||
| − | |||
---- | ---- | ||
Back to [[Eclipse Documentation]] | Back to [[Eclipse Documentation]] | ||
Revision as of 10:19, 26 July 2012
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
- remember to remove the plug-in from -classpath if it was already there
- code of required plug-ins must be added on the -classpath (unless they are already on the -sourcepath)
- non-JARed plug-ins: Path(s) to the JAR(s)
- JARed plug-ins: <plugin>/@dot
- plug-ins not built during the platform build: path to the built JAR
Caveat: the JAR name typically contains a version:- Either remember to update the version in the reference whenever a new version is used
- Or (since 3.8 incl. maintenance branches) replace the
_<major>.<minor>.<service>.<qualifier>with_*if only one version of the JAR is present during the build.
- the API package names must be included in the (alphabetical) package list at the end of the file
- the plug-in's source folder(s) must be included on the -sourcepath
- 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 or package-info.java 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