fixed a bug with SVG width on recent Chrome browsers + externalized data to separate more data and logic + added alternative views of the same data + more detailed README

Author: Fabien Basmaison

README

@@ -0,0 +1,41 @@
+This project provides a fast "database free" way to update a burndown chart
+
+The PHP could of course use classes and the like, this is far from clean.
+Feel free to improve by forking. :)
+
+
+# Usage
+
+* Every day, you can update the file data.php to reflect points burned, User Story points removed and bugs fixing time;
+* If you don't want to differentiate points and User Story points, you can remove things related to User Story points;
+* If the sprint is unusualy long, the legends might not look really good. You can add the class ".long_sprint" to the "#grid" element.
+* Since you might have multiple sprints, you can move "common.css" to an other folder and refer to it accordingly to keep styles consistent whatever modifications are made on the CSS.
+
+
+
+# Variables
+
+All variables are defined in the $sprint array.
+* number:         number of the current sprint (could be called sprintID);
+* days:           amount of days in the sprint;
+* points:         total number of points for Tasks commited to during the sprint;
+* USPoints:       total number of points for User Stories in the sprint;
+* dailyPoints:    array to be updated daily, based on the number of tasks points burned in the previous day;
+* dailyUSPoints:  array to be updated daily, based on the number of points for User Stories finished the previous day;
+* dailyBugs:      array to be updated daily, based on the time spent on bugs during the previous day.
+
+
+
+# Projections
+
+Two projections are are available:
+* a global projection: sprint success estimation based on the average points burned since the start of the sprint;
+* a local projection:  sprint success estimation based on the points burned during the last day.
+
+
+
+# Alternate views
+
+* "burndown_chart_success.php" shows the sprint as if it was successful.
+* "burndown_chart_added_hours.php" shows the cumulative hours spent on bug fixing and burned hours. This can explain how much work was globally done, even if the sprint is unsuccessful.
+* "burndown_chart_embed.php" is an work in progress to show how a table could be used by the SVG with JS. You'll need to update the header of the SVG file for this to work. (Just add "/*" where necessary)

README.textile

@@ -1,7 +1,8 @@
 <?php
-/* The 3 following lines should be commented when the files is direclty embedded in a HTML5 document.
-   On the contrary, the 3 following lines shouldn't be commented if this php file is used as standalone
-   Just add [starSlash] caracters at the end of this line for standalone use. */
+/* You don't want that when you embed the file direclty in the HTML.
+   The 3 following lines should be commented when the files is direclty embedded in a HTML5 document.
+   On the contrary, the 3 following lines shouldn't be commented if this php file is used as a standalone
+   Just add [starSlash] caracters at the end of this line. */
   header("Content-type: image/svg+xml");
   echo '<?xml version="1.0" encoding="utf-8"?>
   <?xml-stylesheet href="common.css" type="text/css"?>';
@@ -12,49 +13,16 @@
    */
   $variation = isset($_GET['var']) ? $_GET['var'] : 12;
 
-  /*
-   * Some data you'd like to change and update daily (dailyPoints & dailyUSPoints)
-   * numbers in parentheses are added hours to the sprint
-   *
-   */
-  $sprint = array(
-    'number'        => 34,
-    'days'          => 15,
-    'points'        => 10+61+22+6+77+2+6+4+20+30,
-    'USPoints'      => 8+13+3+3+20+1+3+1+13+8,
-
-    /*
-     * 2012
-     *
-     */
-    'dailyPoints'   => array(
-                              1+3+5+1,  // day 1
-                              1+5+2,    // day 2
-                              6+6+6+6   // day 3
-                            ),
-    'dailyUSPoints' => array(
-                              0,    // day 1
-                              1,    // day 2
-                              3+5   // day 3
-                            ),
-    /*
-     * 2012
-     *
-     */
-    'dailyBugs' => array(
-                          1+2+3,  // day 1
-                          5+5+5,  // day2
-                          2       // day 3
-                        )
-  );
+  /* Don't embed data in this file to allow more flexibility */
+  require('data.php');
 
   $graphWidth     = 2000;
   $graphHeight    = 1000;
   $GraphMargin    = 150;
   $unitPoint      = $graphHeight / $sprint['points'];
   $unitDay        = $graphWidth / $sprint['days'];
   $coordsModifier = $sprint['points'] - $sprint['USPoints'];  /* to adapt the number of US points to the scale of tasks points */
-  $bugsModifier   = 2;                                        /* so that the chart is not too tiny compared to the rest */
+  $bugsModifier   = 2;                                        /* so that the bug chart is not too tiny compared to the rest */
 
   $arrayTasksCoords = array();
   $arrayUSCoords = array();