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 and plug-in dependencies, 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: &lt;plugin&gt;/@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.

−

# '''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 '''&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 <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

−

#* Create a package.html file for your API package, and place it in the package alongside the source code

+

#* Create a package.html or package-info.java file for your API package, and place it in the package alongside the source code

−

# '''tocreference.xml'''

+

# topics_Reference.xml

#* add a line for each API package

#* add a line for each API package

−

# '''hrml/reference/misc/overview-mtj.html'''

+

# reference/misc/overview-platform.html

#* add the API packages to the corresponding section

#* add the API packages to the corresponding section

−

# '''platformOptions.txt'''

+

# platformOptions.txt

#* 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'''

+

# reference/extension-points/index.html

#* add a line for each extension point

#* add a line for each extension point

−

# '''tocreference.xml'''

+

# topics_Reference.xml

#* add a line for each extension point

#* add a line for each extension point

+

+

----

+

Back to [[Eclipse Documentation]]

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:

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 JARCaveat: 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)

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