| Re: [wtp-releng] How to generate javadoc like jsf |
|
*********************** Warning: Your file, org.eclipse.component.doc.isv.zip, contains more than 32 files after decompression and cannot be scanned. *********************** |
I have added anchors for each component to the WTP master table of contents (org.eclipse.wst.doc.user\reference_toc.xml) - this will allow you to group all the WTP javadoc and extensions point reference info into one location in the help.
The current anchors are:
<anchor id="javadoc_common"/>
<anchor id="javadoc_ejbtools"/>
<anchor id="javadoc_jeetools"/>
<anchor id="javadoc_servertools"/>
<anchor id="javadoc_sourceediting"/>
<anchor id="javadoc_xml"/>
<anchor id="javadoc_webservices"/>
If you would like additional anchors added, please append the request to bugzilla 231199.
I'm appending a sample javadoc plugin to this email so that you can take a look at how to structure your plugin and push your javadoc into the help, but for those of you who cannot receive attachments I'll try to go over the highlights in this email.
(See attached file: org.eclipse.component.doc.isv.zip)
Plugin:
Create a plugin which will contain your javadoc and extensions reference info. It's structure should look like the following:
org.eclipse.component.doc.isv
META-INF
manifest.mf
reference
api (content in this folder generated by PDE javadoc tools)
index-files
+org
resources
*.html
extension-points
index.html
extensionpoint_x.html
about.htm
build.properties
componentname_javadoc_toc.xml (you can rename this - just ensure it matches what is in the plugin.xml)
plugin.properties
plugin.xml
Plugin.xml
Your plugin.xml needs the following extension point defined to appear in the help:
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension point="org.eclipse.help.toc">
<toc file="componentname_javadoc_toc.xml"/>
</extension>
</plugin>
Please do not add primary=true to this extension point (even though a lot of other plugins do this). This will push your documentation to the highest level of the help, and WTP and every adoptor product will need to manually add a reference to your plugin to get it to appear in the correct location. As long as you have a valid anchor in your table of contents, your content will display in the help.
Javadoc table of contents:
Your componentname_javadoc_toc.xml file is used to pull the files into the table of contents. It should look similar to the following (ensure that you change "component_name" to whatever you want users to see, and "#javadoc_componentname" to whichever anchor you want to use from the list above):
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<!-- ============================================================================= -->
<!-- Define topics for the componentname reference documentation -->
<!-- ============================================================================= -->
<toc label="Component_name Reference" link_to="../org.eclipse.wst.doc.user/reference_toc.xml#javadoc_componentname">
<topic label="Component_name API Reference" href="">
<topic label="org.eclipse.jdt.core" href="">
<topic label="org.eclipse.jdt.core.compiler" href="">
<topic label="org.eclipse.jdt.core.dom" href="">
...
</topic>
<topic label="Component_name Extension Points Reference" href="">
<topic label="org.eclipse.jdt.debug.ui.vmInstallPages" href="">
<topic label="org.eclipse.jdt.debug.ui.vmInstallTypePage" href="">
<topic label="org.eclipse.jdt.junit.junitLaunchConfigs" href="">
<topic label="org.eclipse.jdt.junit.testRunListeners" href="">
...
</topic>
</toc>
Kate Price
WTP user assistance
1-905-413-3757 (T/L 969-3757)
IBM Toronto Lab
katep@xxxxxxxxxx
Amy Wu/Toronto/IBM@IBMCA
Sent by: wtp-releng-bounces@xxxxxxxxxxx 05/08/2008 03:19 PM
|
|
Attachment:
org.eclipse.component.doc.isv.zip
Description: Zip archive