Jump to: navigation, search

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

m (Adding new plug-ins and dependencies)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Last revised May 15, 2006
+
== Adding new plug-ins and dependencies  ==
  
 +
To add new plug-ins and plug-in dependencies, you need to make changes in several places in the org.eclipse.platform.doc.isv plug-in:
  
== Adding new plugins ==
+
#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>_&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
 +
#*variables like <code>${eclipse.platform.resources.bundles}</code> are resolved from <code>cbi_basedirs.properties</code> (and <code>pde_basedirs.properties</code> for the old PDE-based build)
 +
#buildDoc.xml
 +
#*If a plug-in contributes extension points, it should be added to the list of plug-ins in the &lt;convertSchemaToHTML&gt; 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.
  
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 (the JAR(s)for non-JARed plug-ins and &lt;plugin&gt;/@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 &lt;convertSchemaToHTML&gt; 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 plugin's javadoc with the reference section for this doc plugin.
 
 
 
== 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 36:
 
# 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]]

Latest revision as of 01:44, 28 June 2013

Adding new plug-ins and dependencies

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

  1. 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
    • variables like ${eclipse.platform.resources.bundles} are resolved from cbi_basedirs.properties (and pde_basedirs.properties for the old PDE-based build)
  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's Javadoc with the reference section for this doc plug-in.

Adding new API packages

  1. 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
  2. topics_Reference.xml
    • add a line for each API package
  3. reference/misc/overview-platform.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. reference/extension-points/index.html
    • add a line for each extension point
  2. topics_Reference.xml
    • add a line for each extension point

Back to Eclipse Documentation