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

From Eclipsepedia

Jump to: navigation, search
Line 33: Line 33:
 
       </preamble>
 
       </preamble>
 
       <theme name="Appealing to the Broader Community">
 
       <theme name="Appealing to the Broader Community">
         <committed>...bugzilla search url...</committed>
+
         <committed bugzilla="...(recommended) bugzilla search url...">
         <proposed>...bugzilla search url...</proposed>
+
            ...(optional alternate) html...</committed>
         <deferred>...bugzilla search url...</deferred>
+
         <proposed bugzilla="...(recommended) bugzilla search url...">
 +
            ...(optional alternate) html...</proposed>
 +
         <deferred bugzilla="...(recommended) bugzilla search url...">
 +
            ...(optional alternate) html...</deferred>
 
       </theme>
 
       </theme>
 
       <theme name="Design for Extensibility">
 
       <theme name="Design for Extensibility">
         <committed>...bugzilla search url...</committed>
+
         <committed bugzilla="...(recommended) bugzilla search url...">
         <proposed>...bugzilla search url...</proposed>
+
            ...(optional alternate) html...</committed>
         <deferred>...bugzilla search url...</deferred>
+
         <proposed bugzilla="...(recommended) bugzilla search url...">
 +
            ...(optional alternate) html...</proposed>
 +
         <deferred bugzilla="...(recommended) bugzilla search url...">
 +
            ...(optional alternate) html...</deferred>
 
       </theme>
 
       </theme>
 
     </themes_and_priorities>
 
     </themes_and_priorities>
Line 55: Line 61:
 
==Bugs as Plan Items==
 
==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.
 
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.

Revision as of 21:51, 14 April 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 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">
   <release projectid="technology.dash" version="1.0"/>
   <introduction>
     ...html...
   </introduction>
   <release_deliverables>
     ...html...
    </release_deliverables>
   <release_milestones>
      <preamble>...html...</preamble>
      <milestone date="7/1/2008" milestone="M1">...optional html...</milestone>
      <milestone date="8/1/2008" milestone="M2">...optional html...</milestone>
      <milestone date="9/1/2008" milestone="RC1">...optional html...</milestone>
      <milestone date="6/28/2009" milestone="1.0"/>
      <postamble>...html...</postamble>
   </release_milestones>
   <target_environments>
     ...html...
     <internationalization>
       ...html...
     </internationalization>
   </target_environments>
   <compatibility_with_previous_releases>
     ...html...
   </compatibility_with_previous_releases>
   <themes_and_priorities>
     <preamble>
       ...html...
     </preamble>
     <theme name="Appealing to the Broader Community">
        <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">
        <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 if your HTML blocks contain non-XML-parseable HTML, you'll want to enclose them in a CDATA section, e.g.,

 <introduction><![[CDATA[ ... ]]></introduction>

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

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.