platform-doc-home/docs/isvdoc_component_ref_guidelines.html
Parent Directory
| 
Revision Log
Revision 1.2 - (view) (download) (as text)
| 1 : | sfranklin | 1.1 | <html> |
| 2 : | <head> | ||
| 3 : | <title>Platform ISV Doc Plan</title> | ||
| 4 : | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | ||
| 5 : | <link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css"> | ||
| 6 : | </head> | ||
| 7 : | |||
| 8 : | <body bgcolor="#FFFFFF" text="#000000"> | ||
| 9 : | |||
| 10 : | |||
| 11 : | <h1>Component Owner Responsibilities - Platform ISV Doc</h1> | ||
| 12 : | <p>The reference guide section of the Platform ISV documentation is generated at | ||
| 13 : | build time based on content supplied by component owners. It is important | ||
| 14 : | that component owners supply the required reference doc in the proper location | ||
| 15 : | for all public API.</p> | ||
| 16 : | <h2>Extension Points</h2> | ||
| 17 : | <p>If your component defines an extension point, you should supply a complete | ||
| 18 : | definition of the extension point for the reference documentation. These | ||
| 19 : | are supplied as HTML files which are copied to the org.eclipse.platform.isv.doc | ||
| 20 : | plug-in at build time.</p> | ||
| 21 : | <p>Extension point definitions are copied from a "doc" subdirectory | ||
| 22 : | located directly underneath your plug-in's directory in the repository. | ||
| 23 : | For example, the workbench extension point documentation is located in </p> | ||
| 24 : | <pre>/home/eclipse/org.eclipse.ui/doc</pre> | ||
| 25 : | <p>The "doc" subdirectory should only be used for extension point | ||
| 26 : | definitions. If you have not supplied extension point definitions in | ||
| 27 : | previous builds but need to contribute them, contact <a href="http://dean_roberts@oti.com">Dean | ||
| 28 : | Roberts</a> to ensure that your component's doc directory is added to the script | ||
| 29 : | that builds the reference material.</p> | ||
| 30 : | sfranklin | 1.2 | <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> |
| 31 : | sfranklin | 1.1 | <h2>Examples Guide</h2> |
| 32 : | <p>If you ship example plug-ins, you should be providing a summary document for | ||
| 33 : | each example provided. This should be an HTML file that describes the | ||
| 34 : | purpose of the example and gives the user enough information to run the example | ||
| 35 : | and start looking at the source code. The example doc files are copied to | ||
| 36 : | the org.eclipse.platform.isv.doc plug-in at build time.</p> | ||
| 37 : | <p>Example summaries are copied from a "doc-html" subdirectory located | ||
| 38 : | directly underneath your example plug-in's directory in the repository. | ||
| 39 : | For example, the SWT examples doc is located in</p> | ||
| 40 : | <pre>/home/eclipse/org.eclipse.swt.examples/doc-html | ||
| 41 : | /home/eclipse/org.eclipse.swt.examples.controls/doc-html | ||
| 42 : | /home/eclipse/org.eclipse.swt.examples.launcher/doc-html | ||
| 43 : | ...</pre> | ||
| 44 : | <p>The "doc-html" subdirectory should only be used for extension point | ||
| 45 : | definitions. If you have not supplied extension point definitions in | ||
| 46 : | previous builds but need to contribute them, contact <a href="http://dean_roberts@oti.com">Dean | ||
| 47 : | Roberts</a> to ensure that your component's example doc-html directory is added | ||
| 48 : | to the script that builds the reference material.</p> | ||
| 49 : | <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 | ||
| 50 : | Text Editor</a>.</p> | ||
| 51 : | <h2>Misc. Reference Documents</h2> | ||
| 52 : | <p>Some components have specific reference documentation needs. For | ||
| 53 : | example, the core component contributes many reference documents, such as the | ||
| 54 : | component manifest file format, Eclipse command-line arguments, etc.</p> | ||
| 55 : | <p>If you need to contribute specialized reference material, contact <a href="mailto:susan_franklin@oti.com">Susan | ||
| 56 : | Franklin</a> to ensure that this material gets added to the ISV doc | ||
| 57 : | plug-in. If you have commit rights to org.eclipse.platform.doc.isv, you | ||
| 58 : | may commit the material to </p> | ||
| 59 : | <pre>/home/eclipse/org.eclipse.swt.examples/doc-html</pre> | ||
| 60 : | <p>You will still need to contact Susan so that the file can be reviewed and the | ||
| 61 : | XML table of contents can be updated to include your new doc.</p> | ||
| 62 : | <h2>Javadoc</h2> | ||
| 63 : | <p>Javadoc is generated at build time based on a list of packages in </p> | ||
| 64 : | <pre>/home/eclipse/org.eclipse.platform.doc.isv/platformOptions.txt</pre> | ||
| 65 : | <p>If you need to add or delete a package from the javadoc, contact <a href="http://dean_roberts@oti.com">Dean | ||
| 66 : | Roberts</a> to ensure the platformOptions file is updated and the XML table of | ||
| 67 : | contents is corrected.</p> | ||
| 68 : | |||
| 69 : | |||
| 70 : | </body> | ||
| 71 : | </html> |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |