Jump to: navigation, search

Difference between revisions of "DSDP/MTJ/Developer Resources/Developer guide"

(Adding new extension points)
(Style Guide)
 
(7 intermediate revisions by the same user not shown)
Line 6: Line 6:
  
 
# '''mtjOptions.txt'''
 
# '''mtjOptions.txt'''
#* the plug-in source folder(s) must be included on the '''-sourcepath'''
+
#* the plug-in source folder(s) must be included on the <span style="color:#008000;">'''-sourcepath'''</span>
#* 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
+
#* code of required plug-ins must be added on the <span style="color:#008000;">'''-classpath'''</span> (the JAR(s)for non-JARed plug-ins and <span style="color:#008000;">'''&lt;plugin&gt;/@dot'''</span> for JARed plug-ins
 
#* 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
 
# '''buildDoc.xml'''
 
# '''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.
+
#* If a plug-in contributes extension points, it should be added to the list of plug-ins in the <span style="color:#008000;">'''&lt;convertSchemaToHTML&gt;'''</span> task in the buildDoc.xml of the corresponding documentation plug-in.
 
# '''plugin.xml'''
 
# '''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.
+
#* If your plugin has javadoc API, add a line to plugin.xml under the <span style="color:#008000;"><code>org.eclipse.pde.core.javadoc</code></span> extension to associate your plug-in javadoc with the reference section for this doc plugin.
+
 
 
=== Adding new API packages ===
 
=== Adding new API packages ===
  
Line 20: Line 20:
 
# '''tocreference.xml'''
 
# '''tocreference.xml'''
 
#* add a line for each API package
 
#* add a line for each API package
# '''hrml/reference/misc/overview-mtj.html'''
+
# '''html/reference/misc/overview-mtj.html'''
 
#* add the API packages to the corresponding section
 
#* add the API packages to the corresponding section
 
# '''platformOptions.txt'''
 
# '''platformOptions.txt'''
Line 32: Line 32:
 
#* add a line for each extension point
 
#* add a line for each extension point
  
[[Category:DSDP]] [[Category:MTJ]]
 
  
----
+
== Documentation Guides ==
  
 +
=== Style Guide ===
 +
 +
Refer to the [[Eclipse_Doc_Style_Guide|Eclipse Doc Style Guide]] for style conventions to be used in Eclipse help.
 +
 +
=== Checklist ===
 +
 +
Refer to the [[Eclipse_Doc_Checklist|Eclipse Doc Checklist]] for the checklist that can be used to ensure that all documentation work for a component gets completed.
 +
 +
 +
 +
----
 
''based on [[How_to_add_things_to_the_Eclipse_doc]]''
 
''based on [[How_to_add_things_to_the_Eclipse_doc]]''
 +
 +
[[Category:DSDP]] [[Category:MTJ]]

Latest revision as of 10:39, 30 January 2009

How to add things to the Developer Guide doc

Adding new plug-ins

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

  1. 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 <plugin>/@dot for JARed plug-ins
    • the API package names must be included in the (alphabetical) package list at the end of the file
  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 javadoc with the reference section for this doc plugin.

Adding new API packages

  1. package.html
    • Create a package.html file for your API package, and place it in the package alongside the source code
  2. tocreference.xml
    • add a line for each API package
  3. html/reference/misc/overview-mtj.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. html/reference/extension-points/index.html
    • add a line for each extension point
  2. tocreference.xml
    • add a line for each extension point


Documentation Guides

Style Guide

Refer to the Eclipse Doc Style Guide for style conventions to be used in Eclipse help.

Checklist

Refer to the Eclipse Doc Checklist for the checklist that can be used to ensure that all documentation work for a component gets completed.



based on How_to_add_things_to_the_Eclipse_doc