Difference between revisions of "How to add things to the Eclipse doc"

Revision as of 10:18, 26 July 2012

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
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.

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

@@ Line 9: / Line 9: @@
 #** non-JARed plug-ins: Path(s) to the JAR(s)
 #** JARed plug-ins: &lt;plugin&gt;/@dot
-#** plug-ins not built during the platform build: Name of the built JAR ('''Caveat:''' remember to update the version in the reference whenever a new version is used)
+#** 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>_&lt;major&gt;.&lt;minor&gt;.&lt;service&gt;.&lt;qualifier&gt;</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