platform-doc-home/docs/isvdoc_component_ref_guidelines.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (download) (as text) (annotate)
Thu May 23 02:51:48 2002 UTC (7 years, 6 months ago) by sfranklin
Branch: MAIN
CVS Tags: HEAD
Changes since 1.1: +1 -1 lines 
correct link to extension point doc

<html>
<head>
<title>Platform ISV Doc Plan</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css">
</head>

<body bgcolor="#FFFFFF" text="#000000">


<h1>Component Owner Responsibilities - Platform ISV Doc</h1>
<p>The reference guide section of the Platform ISV documentation is generated at
build time based on content supplied by component owners.&nbsp; It is important
that component owners supply the required reference doc in the proper location
for all public API.</p>
<h2>Extension Points</h2>
<p>If your component defines an extension point, you should supply a complete
definition of the extension point for the reference documentation.&nbsp; These
are supplied as HTML files which are copied to the org.eclipse.platform.isv.doc
plug-in at build time.</p>
<p>Extension point definitions are copied from a &quot;doc&quot; subdirectory
located directly underneath your plug-in's directory in the repository.&nbsp;
For example, the workbench extension point documentation is located in </p>
<pre>/home/eclipse/org.eclipse.ui/doc</pre>
<p>The &quot;doc&quot; subdirectory should only be used for extension point
definitions.&nbsp; If you have not supplied extension point definitions in
previous builds but need to contribute them, contact <a href="http://dean_roberts@oti.com">Dean
Roberts</a> to ensure that your component's doc directory is added to the script
that builds the reference material.</p>
<p>Here is the extension point document for <a href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.ui/doc/org_eclipse_ui_popupMenus.html">org.eclipse.ui.popupMenus</a>.</p>
<h2>Examples Guide</h2>
<p>If you ship example plug-ins, you should be providing a summary document for
each example provided.&nbsp; This should be an HTML file that describes the
purpose of the example and gives the user enough information to run the example
and start looking at the source code.&nbsp; The example doc files are copied to
the org.eclipse.platform.isv.doc plug-in at build time.</p>
<p>Example summaries are copied from a &quot;doc-html&quot; subdirectory located
directly underneath your example plug-in's directory in the repository.&nbsp;
For example, the SWT examples doc is located in</p>
<pre>/home/eclipse/org.eclipse.swt.examples/doc-html
/home/eclipse/org.eclipse.swt.examples.controls/doc-html
/home/eclipse/org.eclipse.swt.examples.launcher/doc-html
...</pre>
<p>The &quot;doc-html&quot; subdirectory should only be used for extension point
definitions.&nbsp; If you have not supplied extension point definitions in
previous builds but need to contribute them, contact <a href="http://dean_roberts@oti.com">Dean
Roberts</a> to ensure that your component's example doc-html directory is added
to the script that builds the reference material.</p>
<p>Here is the example doc for the <a href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.swt.examples/doc-html/swt_texteditor_ex.html">SWT
Text Editor</a>.</p>
<h2>Misc. Reference Documents</h2>
<p>Some components have specific reference documentation needs.&nbsp; For
example, the core component contributes many reference documents, such as the
component manifest file format, Eclipse command-line arguments, etc.</p>
<p>If you need to contribute specialized reference material, contact <a href="mailto:susan_franklin@oti.com">Susan
Franklin</a> to ensure that this material gets added to the ISV doc
plug-in.&nbsp; If you have commit rights to org.eclipse.platform.doc.isv, you
may commit the material to </p>
<pre>/home/eclipse/org.eclipse.swt.examples/doc-html</pre>
<p>You will still need to contact Susan so that the file can be reviewed and the
XML table of contents can be updated to include your new doc.</p>
<h2>Javadoc</h2>
<p>Javadoc is generated at build time based on a list of packages in </p>
<pre>/home/eclipse/org.eclipse.platform.doc.isv/platformOptions.txt</pre>
<p>If you need to add or delete a package from the javadoc, contact <a href="http://dean_roberts@oti.com">Dean
Roberts</a> to ensure the platformOptions file is updated and the XML table of
contents is corrected.</p>


</body>
</html>