Difference between revisions of "Development Resources/Project Plan/XML"

Revision as of 18:34, 22 August 2008

As per a resolution from the Board that led to bug 215301, all projects are required to provide their current project plan in the following XML format.

XML Template

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<?xml-stylesheet type="text/xsl" href="http://www.eclipse.org/projects/project-plan.xsl"?>
<plan plan-format="1.0" xmlns="http://www.eclipse.org/project/plan" xmlns:html="http://www.w3.org/1999/xhtml"
      name="Project Name">
   <release projectid="technology.dash" version="1.0"/>
   <introduction>
     <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
   </introduction>
   <release_deliverables>
     <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
   </release_deliverables>
   <release_milestones>
      <preamble>
         <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
      </preamble>
      <milestone date="7/1/2008" milestone="M1"><html:p>optional html</html:p></milestone>
      <milestone date="8/1/2008" milestone="M2"><html:p>optional html</html:p></milestone>
      <milestone date="9/1/2008" milestone="RC1"><html:p>optional html</html:p></milestone>
      <milestone date="6/28/2009" milestone="1.0"/>
      <postamble><html:p>html content</html:p></postamble>
   </release_milestones>
   <target_environments>
     <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
     <internationalization>
          <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
     </internationalization>
   </target_environments>
   <compatibility_with_previous_releases>
       <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
   </compatibility_with_previous_releases>
   <themes_and_priorities>
     <preamble>
         <html:p>Some xhtml content here.  Make sure to use the prefix before the elements</html:p>
     </preamble>
     <theme name="Appealing to the Broader Community">
        <description>...(optional) html...</description>
        <committed bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</committed>
        <proposed bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</proposed>
        <deferred bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</deferred>
     </theme>
     <theme name="Design for Extensibility">
        <description>...(optional) html...</description>
        <committed bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</committed>
        <proposed bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</proposed>
        <deferred bugzilla="...(recommended) bugzilla search url...">
           ...(optional alternate) html...</deferred>
     </theme>
   </themes_and_priorities>
   <appendix name="Project Refactoring">
     ...html...
   </appendix>	
 </plan>

Note that the HTML content must be prefixed with the correct namespace prefix, and the XHTML namespace must be included. XHTML is required as it will allow for tooling to help with validation and editting support. Do not Wrap your XHTML content with CDATA. Anywhere it says to use HTML content, you should be using XHTML which is the XML equivalent of HTML.

Obviously, the milestone, theme and appendix elements can be repeated as many times as necessary.

XML Schema

The XML Schema for the above spec is still in flux. See bug 243303 for the latest.

• projectplan.xsd, 2008-08-22

If you have the WTP XML Developer Tools installed you can add the Schema to the XML Catalog. This will give you content assistance and validation support. Also by using the schema, you can generate a sample XML instance from the schema which will give you a template to start with.

The XML instance that this schema represents uses the XHTML namespace. This should also be added to the XML Catalog. The url for the XHTML schema is:

http://www.w3.org/2002/08/xhtml/xhtml1-strict.xsd

See the WTP documentation for additional information about adding items to the XML Catalog.

Note: In order for the plan to render, it MUST be valid against the schema it. It is highly recommended that you validate your XML against the schema. The Eclipse Web Tools project provides all the necessary tools to do the validation.

Bugs as Plan Items

The goal of the bugzilla queries is to support the use of bugzilla items for planning. The project team should assign target milestones to each bug, including both defects and enhancements. Additionally, the team should assign keywords (or keywords-in-titles) to each bug entry in order to classify them into themes. The bugzilla queries would then be, e.g., "all 2.6M1, 2.6M2, 2.6M3, ..., 2.6 bugs with keyword 'designforextensibility'", etc.

If a project chooses not to use bugzilla item for planning (contrary to collective wisdom of the senior Eclipse project leads), the project plan format allows arbitrary html text paragraph(s) instead.

Specifying the Plan

The project plan xml file is placed in the project's website CVS. The project meta-data item "projectplanurl" is then defined to point to that xml file. Use the portal to modify the project meta-data.

Note that in addition for specifying your "current plan" in the Portal, bug 238434 is open requesting an ability to render arbitrary XML project plans as HTML.

Examples

• Dash Sample

• Rendered as HTML
• Styled XML
• Raw XML (view page source for XML)