├── example-book.jpg
├── status
    ├── post-receive
    ├── status.rss.php
    ├── png.php
    ├── graph.php
    ├── status.php
    └── docx2html.xsl
├── .gitignore
├── Makefile
├── example-book.tex
├── status.conf
└── README.md


/example-book.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/smarr/WritingStats/HEAD/example-book.jpg


--------------------------------------------------------------------------------
/status/post-receive:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | # update directory
 3 | cur=`hostname`
 4 | soft="soft.vub.ac.be"
 5 | 
 6 | if [ "$cur" = "$soft" ]
 7 | then
 8 |   GIT_WORK_TREE=checkout git reset --hard
 9 |   cd checkout
10 |   make pdf
11 |   status/status.php
12 | fi
13 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # LaTeX specific
 2 | *.aux
 3 | *.idx
 4 | *.log
 5 | *.synctex.gz
 6 | *.pdf
 7 | *.toc
 8 | *.idx.old
 9 | *.ilg
10 | *.ind
11 | *.ind.old
12 | 
13 | # Statistic Data
14 | status/status.data
15 | status/status.html
16 | status/status.items
17 | status/status.txt
18 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | # This Makefile relies on LaTeX-Mk
 2 | # See: http://latex-mk.sourceforge.net/
 3 | 
 4 | NAME=example-book
 5 | TEXSRCS=example-book.tex
 6 | USE_PDFLATEX=true
 7 | 
 8 | CLEAN_FILES+=$(wildcard *.synctex.gz)
 9 | 
10 | # We are going to try a couple of standard locations to find LaTeX-Mk:
11 | -include /opt/local/share/latex-mk/latex.gmk
12 | -include /usr/local/share/latex-mk/latex.gmk
13 | -include ~/.local/share/latex-mk/latex.gmk
14 | 


--------------------------------------------------------------------------------
/example-book.tex:
--------------------------------------------------------------------------------
 1 | % Very simple example tex file to demonstrate the setup of WritingStats
 2 | \documentclass[12pt]{book}
 3 | 
 4 | \makeindex
 5 | 
 6 | \title{A Simple \LaTeX \ Book Example}
 7 | 
 8 | \author{Jane Doe}
 9 | \date{21st of December 2012}
10 | 
11 | \begin{document}
12 | 
13 | \maketitle
14 | \tableofcontents
15 | 
16 | \chapter{Introduction}
17 | 
18 | Here goes the introduction.
19 | 
20 | 
21 | \chapter{Main Part}
22 | 
23 | Here perhaps the main content.
24 | 
25 | 
26 | \chapter{Conclusion}
27 | 
28 | And finally, the conclusion.
29 | 
30 | 
31 | \end{document}
32 | 


--------------------------------------------------------------------------------
/status/status.rss.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | header('Content-Type: application/rss+xml; charset=UTF-8');
 3 | 
 4 | date_default_timezone_set('Europe/Brussels');
 5 | 
 6 | $folder = dirname(__FILE__);
 7 | 
 8 | $items = $folder.'/status.items';
 9 | 
10 | echo '<?xml version="1.0"?>
11 | <rss version="2.0">
12 |   <channel>
13 |     <title>Thesis Status</title>
14 |     <link>http://www.stefan-marr.de/</link>
15 |     <description>Current Metrics of the Thesis Text</description>
16 |     <language>en-en</language>
17 |     <pubDate>'.date('r', filemtime($items)).'</pubDate>
18 |     <lastBuildDate>'.date('r', filemtime($items)).'</lastBuildDate>
19 |     <docs>http://stefan-marr.de/phd/status.rss.php</docs>
20 |     <ttl>120</ttl>
21 |     
22 |     '.file_get_contents($items).'
23 | 
24 |   </channel>
25 | </rss>';


--------------------------------------------------------------------------------
/status.conf:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // Files
 3 | $mainfile = 'example-book.tex';  // Main file of your LaTeX project
 4 | $logfile  = 'example-book.log';  // Log file generated by LaTeX
 5 | $pdffile  = 'example-book.pdf';  // PDF file
 6 | 
 7 | // Goal and project details
 8 | $target_page_number_body = 150;  // body pages, i.e., without index, TOC, etc.
 9 | $overhead_pages          =  18;  // good guess for the amount of pages in the
10 |                                  // resulting document that are not body pages
11 | 
12 | $words_per_page    = 350;        // depends on use template, font size, etc.
13 | $target_word_count = $target_page_number_body * $words_per_page; // could be a constant, too.
14 | 
15 | $deadline  = '1 September 2012';         // When does it need to be done?
16 | $start_day = 'Saturday, 31. March 2012'; // When do writing start?
17 | 
18 | 
19 | 
20 | // Typically, only the local place needs to be changed here:
21 | date_default_timezone_set('Europe/Brussels');
22 | setlocale(LC_TIME, 'C');
23 | 
24 | // $duration := days, for the scale on charts
25 | $duration = diff_in_days(strtotime($start_day),
26 |                          strtotime($deadline));
27 | 
28 | // Since these scripts are executed on a wide range of systems, the
29 | // installation path of TeXcount is rather unpredictable, adapt as needed:
30 | function determine_texcount_bin() {
31 |     return file_exists($_SERVER['HOME'].'/.local/bin/texcount')
32 |               ? '~/.local/bin/texcount'
33 |               : '/usr/local/bin/texcount';
34 | }
35 | 


--------------------------------------------------------------------------------
/status/png.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // This script generates an overview image of the PDF.
 3 | // We use the number of pages given in the configuration as a constant for
 4 | // the overview image's dimensions.
 5 | $total_pages = $target_page_number_body + $overhead_pages;
 6 | 
 7 | /**
 8 |  * 1.  area = width * height
 9 |  * 2.  width / height = ratio
10 |  * 3.  ratio > 1,3
11 |  * 4.  ratio < 1,78
12 |  *   
13 |  *   area / height = width
14 |  *   area / width  = height
15 |  *   
16 |  *   width = ratio * height
17 |  *   height = width / ratio
18 |  *   
19 |  *   area / height = ratio * height
20 |  *   area = ratio * height * height
21 |  * 
22 |  *   height = sqrt(area / ratio)
23 |  *   
24 |  *   area / width = width / ratio
25 |  *   area = width * width / ratio
26 |  *   
27 |  *   width = sqrt(area * ratio)
28 |  */
29 | function determine_rect($pages) {
30 |   $ratio  = ((1 + sqrt(5)) / 2) /*Goldener Schnitt*/  * sqrt(2) /* A4 ratio, because pages aren't square */;
31 |   $height = (int)sqrt($pages / $ratio);
32 |   $width  = (int)sqrt($pages * $ratio);
33 |   return array($width, $height);
34 | }
35 | 
36 | function determine_adjusted_rect($pages) {
37 |   list($width, $height) = determine_rect($pages);
38 | 
39 |   if ($pages > $width * $height) $width  += 1;
40 |   if ($pages > $width * $height) $height += 1;
41 |   return array($width, $height);
42 | }
43 | 
44 | list($width, $height) = determine_adjusted_rect($total_pages);
45 | 
46 | if ($pages > $width * $height) {
47 |   list($width, $height) = determine_adjusted_rect($pages);
48 | }
49 | 
50 | mkdir("tmp");
51 | shell_exec("convert $pdffile tmp/$pdffile-%04d.png");
52 | 
53 | $cmd = "montage -background \#ffffff -geometry +0+0 -tile {$width}x{$height} \"tmp/{$pdffile}-*.png\" status/overview-{$version_count}.png";
54 | shell_exec($cmd);
55 | shell_exec("rm -rf tmp");
56 | shell_exec("chmod a+r status/overview-*.png");


--------------------------------------------------------------------------------
/status/graph.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | error_reporting(E_ALL | E_STRICT);
  3 | 
  4 | function get_graph_data() {
  5 |   global $start_day;
  6 |   global $duration;
  7 |   global $target_page_number_body;
  8 |   global $target_word_count;
  9 | 
 10 | // Config
 11 | 
 12 | $data_file = dirname(__FILE__).'/status.data';
 13 | 
 14 | // code
 15 | $start_timestamp = strtotime($start_day);
 16 | $row = 0;
 17 | $content = array(); // the normal file content
 18 | $byDate  = array(); // dictionary by date
 19 | 
 20 | // initialize arrays
 21 | $wordDiff = array(); $pageDiff = array();
 22 | $words    = array(); $pages    = array();
 23 | $commits  = array();
 24 | for ($i = 0; $i < $duration; $i++) {
 25 |   $words[$i] = 0;
 26 |   $pages[$i] = 0;
 27 |   $commits[$i] = 0;
 28 | }
 29 | 
 30 | 
 31 | if (($handle = fopen($data_file, "r")) !== FALSE) {
 32 |   while (($data = fgetcsv($handle, 1000, "\t")) !== FALSE) {
 33 |     $content[$row]    = $data;
 34 |     $timestamp        = strtotime($data[2]); // get timestamp for sorting
 35 |     $content[$row][3] = $timestamp;
 36 |     if ($timestamp) {
 37 |       $byDate[$timestamp]=$data;
 38 |     }
 39 |     $row++;
 40 |   }
 41 |   fclose($handle);
 42 | }
 43 | 
 44 | 
 45 | 
 46 | /// calculating statistics
 47 | $last_day = 0;
 48 | 
 49 | ksort($byDate);
 50 | 
 51 | foreach ($byDate as $date => $value) {
 52 |   $xAxis[] = sprintf("%.2f", diff_in_days($start_timestamp, $date));
 53 |   $wordAxis[] = $value[0];
 54 |   $pagesAxis[] = $value[1];
 55 | 
 56 |   $curDay = (int)floor(diff_in_days($start_timestamp, $date));
 57 |   $commits[$curDay]++;
 58 | 
 59 |   $words[$curDay] = $value[0];
 60 |   $pages[$curDay] = $value[1];
 61 |   while ($last_day < $curDay) {
 62 |     if ($words[$last_day] === 0 && $last_day > 0) {
 63 |       $words[$last_day] = $words[$last_day - 1];
 64 |       $pages[$last_day] = $pages[$last_day - 1];
 65 |     }
 66 |   $last_day++;
 67 |   }
 68 | }
 69 | 
 70 | // generate diffs to previous day
 71 | $wordDiff[0] = 0;
 72 | $pageDiff[0] = 0;
 73 | for ($i = 1; $i <= $last_day; $i++) {
 74 |   $wordDiff[$i] = $words[$i] - $words[$i - 1];
 75 |   $pageDiff[$i] = $pages[$i] - $pages[$i - 1];
 76 | }
 77 | 
 78 | 
 79 | $progressData = "
 80 | [
 81 |     ['x', 'Pages', 'Words', 'Ideal'],";
 82 | 
 83 | while (count($xAxis) > 0) {
 84 |   $x    = array_shift($xAxis);
 85 |   $page = array_shift($pagesAxis);
 86 |   $word = array_shift($wordAxis);
 87 |   
 88 |   $progressData .= "[$x, $page, $word, $target_page_number_body/$duration*$x],\n";
 89 | }
 90 | 
 91 | // Add the ideal line
 92 | $progressData .= "[$duration, null, null, $target_page_number_body],\n";
 93 | $progressData .= "  ]";
 94 | 
 95 | 
 96 | $speedData = "
 97 | [
 98 |   ['x', 'Pages', 'Words', 'Commits'],";
 99 | 
100 | 
101 | for ($i = 0; $i <= $last_day; $i++) { 
102 |   $speedData .= "[$i, ${pageDiff[$i]}, ${wordDiff[$i]}, ${commits[$i]}],\n";
103 | }
104 | $speedData .= "  ]";
105 |   
106 |    return array('progress'    => $progressData,
107 |                 'speed'       => $speedData,
108 |                 'totalWords'  => $target_word_count,
109 |         'targetPages' => $target_page_number_body,
110 |         'duration'    => $duration);
111 | }
112 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | WritingStats: Tracking and Visualizing Writing Progress
  2 | =======================================================
  3 | 
  4 | WritingStats is a collection of scripts to automatically create statistics
  5 | from LaTeX documents and visualize them with an overall progress plots and a
  6 | plot of the daily speed of change.
  7 | 
  8 | Currently, this project provides a setup for a standard LaTeX environment in
  9 | combination with git version tracking.
 10 | 
 11 | Features
 12 | --------
 13 | 
 14 |  - determine page and word count, generate statistics based on them
 15 |  - generate RSS feed with the latest data
 16 |  - generate graphs to visualize progress
 17 | 
 18 | Example
 19 | -------
 20 | 
 21 |     Goal
 22 |     ----
 23 | 
 24 |     Words: 52500
 25 |     Pages: 150
 26 |     Words/Page: ca. 350
 27 |     Draft Deadline: 1 September 2012
 28 | 
 29 |     Current Status
 30 |     --------------
 31 | 
 32 |     Words: 29367
 33 |     Pages: 119
 34 |     Words to be written: 23133
 35 |     Pages to be written: ca. 49
 36 |     Progress: 55.94% finished
 37 |     Remaining Days: 49.21
 38 |     Remaining Workdays: 35.15
 39 |     Remaining Words/Workday: 658
 40 |     Pages/Day: 1.88
 41 |     Current Date: Friday, 13. July 2012 18:50:43
 42 | 
 43 |  ![Progress and Speed Plots](https://github.com/smarr/WritingStats/raw/master/example-book.jpg "Progress and Speed Plots")
 44 | 
 45 | Setup
 46 | -----
 47 | 
 48 | WritingStats depends on the following software:
 49 | 
 50 |  - PHP, command-line interpreter (any recent version should do)
 51 |  
 52 |  - LaTeX-Mk, for the Makefile used in the git post-receive hook  
 53 |    http://latex-mk.sourceforge.net/
 54 |    
 55 |  - TeXcount, for the word count, tested with version 3.0  
 56 |    http://app.uio.no/ifi/texcount/
 57 | 
 58 |  - Google Chart Tools (no installation required, uses online copy)  
 59 |    https://developers.google.com/chart/
 60 | 
 61 | To use WritingStats, clone this repository as template for your new LaTeX 
 62 | project.
 63 | 
 64 |     git clone https://github.com/smarr/WritingStats.git
 65 | 
 66 | Alternatively, check out the repository and copy the following files to your
 67 | existing LaTeX project:
 68 | 
 69 |     cp    Makefile     $YOURFOLDER/
 70 |     cp    status.conf  $YOURFOLDER/
 71 |     cp -R status       $YOURFOLDER/
 72 | 
 73 | ### Customize Settings
 74 | 
 75 | As you have seen in the example above, WritingStats uses a defined goal to
 76 | estimate your progress. The goal and other settings are defined in
 77 | `status.conf`. You will have to set the file name for your main tex file, and
 78 | the name of the log-file LaTeX produces. The log file has typically the same
 79 | name but uses the .log-extension.
 80 | 
 81 | To achieve accurate results, you will need to estimate the number of words per
 82 | page, and how many additional pages the final PDF will contain. Often, you
 83 | will want to ignore for instance the table of content, lists of figures and
 84 | tables, appendices, etc. Since, we currently do not have a way to detect them
 85 | automatically, they will need to be configured instead.
 86 | 
 87 | The settings for start date and deadline are necessary to calculate the length
 88 | of the project, the number of days left, and to size the charts properly.
 89 | 
 90 | Note that the RSS feed needs to be modified separately (cf. below).
 91 | 
 92 | ### Server Repository
 93 | 
 94 | After customizing `status.conf`, we suggest to set up a shared repository on a
 95 | server to automatically generate the statistics on every push to the server.
 96 | Note, this will require that the server is able to generate the PDF file using
 97 | make and LateX-Mk. Furthermore, it will require a installation or local copy
 98 | of TeXcount.
 99 | 
100 | To make sure that the post-receive script only executes the code on the
101 | desired server, we do check the hostname of the machine. Please adapt it for
102 | your deployment!
103 | 
104 | To set up a shared git repository with a post-receive hook, execute the
105 | following steps:
106 | 
107 |  1. Create bare repository on remote server:  
108 |     `git init --bare`
109 |  
110 |  2. Push to the newly create remote repository.
111 |  
112 |  3. Checkout a working copy on the remote server:  
113 |     `mkdir checkout`  
114 |     `GIT_WORK_TREE=checkout git reset --hard`
115 |  
116 |  4. Create a symlink to the post-receive hook:  
117 |     ``ln -s `pwd`/checkout/status/post-receive hooks/post-receive``
118 | 
119 | #### Branches
120 | 
121 | In case you want to use a specific branch, or there is not the normal
122 | master branch, do the following right after creating the `checkout` directory:
123 | 
124 |     `GIT_WORK_TREE=checkout git checkout <branch-name>`
125 | 
126 | ### Graphs and RSS Feed
127 | 
128 | Both, the graphs and RSS feed are now automatically generated by the
129 | post-receive hook. Another side product is the latest PDF. To make them
130 | available on the web, I used symlinks reference `checkout/status/status.html`
131 | with statistics and graphs, `checkout/status/status.rss.php` with the
132 | statistics feed, and `checkout/example-book.pdf` as the latest PDF available
133 | from a public web folder.
134 | 
135 | The RSS feed is published using the `checkout/status/status.rss.php` file.
136 | However, it needs to be adapted to reflect your own project properly. The RSS
137 | feed has a title, description, language, and so on. Furthermore, it contains
138 | the URLs it corresponds to. These settings are not imported from the
139 | `status.conf` file. Instead, they are directly hard code in `status.rss.php`.
140 | Note that the script accesses the `status/status.items` file, which is
141 | automatically generated as part of the post-receive hook.
142 | 
143 | History
144 | -------
145 | 
146 | The foundation of this project was already laid out when I wrote my master
147 | thesis. To track my own progress, I wrote the initial version of these
148 | scripts. However, back then, I was happily using Word and it's XML-based docx
149 | file format. To be able to count words automatically, I used the
150 | `status/docx2html.xsl` XSLT transformation, which also generated reasonably
151 | good HTML from the Word files. The scripts are currently not adapted to use
152 | it, and thus, Word is not supported anymore. However, pull requests to
153 | reintegrate it are of course welcome.
154 | 
155 | License
156 | -------
157 | 
158 | Copyright (c) 2012 Stefan Marr <mail@stefan-marr.de>
159 | 
160 | Permission is hereby granted, free of charge, to any person obtaining a copy
161 | of this software and associated documentation files (the "Software"), to deal
162 | in the Software without restriction, including without limitation the rights
163 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
164 | copies of the Software, and to permit persons to whom the Software is
165 | furnished to do so, subject to the following conditions:
166 | 
167 | The above copyright notice and this permission notice shall be included in all
168 | copies or substantial portions of the Software.
169 | 
170 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
171 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
172 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
173 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
174 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
175 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
176 | SOFTWARE.
177 | 
178 | 


--------------------------------------------------------------------------------
/status/status.php:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/php
  2 | <?php
  3 | error_reporting(E_ALL | E_STRICT);
  4 | 
  5 | $folder = dirname(__FILE__);
  6 | 
  7 | function diff_in_days($start, $end) {
  8 |   $datediff = abs($end - $start);
  9 |   return $datediff / (60 * 60 * 24);  // floor()
 10 | }
 11 | 
 12 | include($folder.'/../status.conf');
 13 | 
 14 | 
 15 | // collect raw data
 16 | $latex_log = file_get_contents($logfile);
 17 | $texcount  = "";
 18 | $texcount_bin = determine_texcount_bin();
 19 | 
 20 | if (!file_exists($texcount_bin)) {
 21 |   die('texcount binary not found. Please check status.conf and make sure it is installed. See: http://app.uio.no/ifi/texcount/download.html');
 22 | }
 23 |   
 24 | 
 25 | $texcount = shell_exec("$texcount_bin -merge $mainfile");
 26 | 
 27 | // process data
 28 | $matches = array();
 29 | preg_match('/Output written on .* \(([0-9]+) page(s)?, [0-9]+ bytes\)./', $latex_log, $matches);
 30 | 
 31 | $pages = (int)$matches[1];
 32 | 
 33 | preg_match('/Words in text: ([0-9]+)/', $texcount, $matches);
 34 | $textWordCnt = (int)$matches[1];
 35 | 
 36 | preg_match('/Words in headers: ([0-9]+)/', $texcount, $matches);
 37 | $headerWordCnt = (int)$matches[1];
 38 | 
 39 | $totalWordCnt = $headerWordCnt + $textWordCnt;
 40 | 
 41 | 
 42 | $deadline_time = strtotime($deadline);
 43 | $today = strtotime('now');
 44 | $timeLeft = round(($deadline_time - $today) / 60 / 60 / 24 * 100) /100; // time left in days
 45 | $timeLeftUseableDays = round($timeLeft * 5 / 7 * 100) / 100;
 46 | 
 47 | $progress = round($totalWordCnt / $target_word_count * 10000) / 100;
 48 | $wordsLeft = $target_word_count - $totalWordCnt;
 49 | $pagesLeft = ($target_page_number_body + $overhead_pages) - $pages;
 50 | $leftWordsPerDay = round($wordsLeft / $timeLeftUseableDays);
 51 | $pagesPerDay = round($leftWordsPerDay / $words_per_page * 100) / 100;
 52 | 
 53 | $result = "Goal\n";
 54 | $result .= "----\n";
 55 | $result .= "\n";
 56 | $result .= "Words: $target_word_count\n";
 57 | $result .= "Pages: $target_page_number_body\n";
 58 | $result .= "Words/Page: ca. $words_per_page\n";
 59 | $result .= "Draft Deadline: $deadline";
 60 | $result .= "\n";
 61 | $result .= "\n";
 62 | $result .= "Current Status\n";
 63 | $result .= "--------------\n";
 64 | $result .= "\n";
 65 | $result .= 'Words: '.$totalWordCnt."\n";
 66 | $result .= 'Pages: '.$pages."\n";
 67 | $result .= 'Words to be written: '.$wordsLeft."\n";
 68 | $result .= 'Pages to be written: ca. '.$pagesLeft."\n";
 69 | $result .= 'Progress: '.$progress."% finished\n";
 70 | $result .= 'Remaining Days: '.$timeLeft."\n";
 71 | $result .= 'Remaining Workdays: '.$timeLeftUseableDays."\n";
 72 | $result .= 'Remaining Words/Workday: '.$leftWordsPerDay."\n";
 73 | $result .= 'Pages/Day: '.$pagesPerDay."\n";
 74 | $result .= 'Current Date: ';
 75 | // Little bit other Syntax but better effect
 76 | $result .= strftime('%A, %d. %B %Y %H:%M:%S');
 77 | $html_result = nl2br(htmlspecialchars($result, ENT_QUOTES, 'UTF-8'));
 78 | 
 79 | 
 80 | 
 81 | // prepend current values to data file for graphs
 82 | $graph_data = file_get_contents($folder.'/status.data');
 83 | $graph_data = "$totalWordCnt\t$pages\t".strftime('%A, %d. %B %Y %H:%M:%S')."\n".$graph_data;
 84 | file_put_contents($folder.'/status.data', $graph_data);
 85 | 
 86 | include($folder.'/graph.php');
 87 | 
 88 | $graphs = get_graph_data();
 89 | 
 90 | 
 91 | 
 92 | 
 93 | $version_count = substr_count($graph_data, "\n");
 94 | include($folder.'/png.php');
 95 | 
 96 | $overview_images = "<div id='images' style='width: 900px;'>\n";
 97 | 
 98 | file_put_contents($folder.'/status.txt', $result);
 99 | 
100 | 
101 | for ($i = 1; $i <= $version_count; $i++) {
102 |   $overview_images .= "<img src='overview-$i.png' style='display:none;width:100%;height:auto;' />\n";
103 | }
104 | $overview_images .= "</div>\n";
105 | 
106 | $rss = "
107 |     <item>
108 |       <title>Current Status: $progress%, $timeLeftUseableDays days left</title>
109 |       <description>".$html_result."</description>
110 |       <pubDate>".date('r').'</pubDate>
111 |       <guid>http://soft.vub.ac.be/~smarr/phd/status.rss.php#'.uniqid().'</guid>
112 |     </item>';
113 | 
114 | $rss .= "\n".file_get_contents($folder.'/status.items');
115 | 
116 | file_put_contents($folder.'/status.items', $rss);
117 | 
118 | 
119 | // Generate the HTML status page
120 | $full_html = '<html><head><title>Latest Stats on PhD Writing Progress</title>
121 |   <script type="text/javascript" src="https://www.google.com/jsapi"></script>
122 |   <script type="text/javascript">
123 | 	      google.load("visualization", "1", {packages:["corechart"]});
124 | 	      google.setOnLoadCallback(drawChart);
125 |         
126 |         var image_nodes = null;
127 |         var img_idx = 0;
128 |         var play = true;
129 |         
130 | 	      function drawChart() {
131 | 	        var progress_data = google.visualization.arrayToDataTable('.$graphs['progress'].');
132 | 	        var speed_data    = google.visualization.arrayToDataTable('.$graphs['speed'].');
133 | 
134 | 	        var progress_options = {
135 | 	          title: "Progress (per day)",
136 | 	          curveType: "function",
137 | 	          width: 900, height: 500,
138 | 	          hAxis: {maxValue: '.$graphs['duration'].', title: "Days"},
139 | 	          vAxes: { 0: {title:"Pages", maxValue: '.$graphs['targetPages'].'},
140 | 	                   1: {title:"Words", maxValue: '.$graphs['totalWords'].'},
141 | 	                   2: {title:"Ideal", maxValue: '.$graphs['targetPages'].'}
142 | 	          },
143 |               series: {
144 | 				       0: {targetAxisIndex: 0},
145 | 					   1: {targetAxisIndex: 1},
146 | 					   2: {targetAxisIndex: 0, color: "#ccc"},
147 | 			     },
148 | 	    };
149 | 			
150 | 			var speed_options = {
151 | 	          title: "Speed",
152 | 			  curveType: "function",
153 | 			  width: 900, height: 500,
154 | 			  hAxis: {title:"Days"},
155 | 			  vAxes: { 0: {title:"Pages"},
156 | 	                   1: {title:"Words"},
157 | 	                   2: {title:"Commits"}
158 | 	          },
159 |               series: {
160 | 				       0: {targetAxisIndex: 0},
161 | 					   1: {targetAxisIndex: 1},
162 | 					   2: {targetAxisIndex: 0, color: "#ccc"},
163 | 			  },
164 | 	        };
165 | 
166 | 	        var progress_chart = new google.visualization.LineChart(document.getElementById("progress"));
167 | 	        progress_chart.draw(progress_data, progress_options);
168 | 	        var speed_chart = new google.visualization.LineChart(document.getElementById("speed"));
169 | 	        speed_chart.draw(speed_data, speed_options);
170 |           
171 |           
172 |           startImageTime();
173 |           image_nodes = document.getElementById("images").children;
174 | 	      };
175 |         
176 |         function startImageTime() {
177 |           setInterval(displayNextImage, 250);
178 |         }
179 |         
180 |         function toggleAnimation() {
181 |           play = !play;
182 |         }
183 |         
184 |         function displayNextImage() {
185 |           if (!play)
186 |             return;
187 |             
188 |           if (img_idx >= image_nodes.length + 10) { // the + 10 adds a little pause after a cycle
189 |             img_idx = 0;
190 |           }
191 |           
192 |           if (img_idx < image_nodes.length) {
193 |             var old_idx = (img_idx == 0) ? image_nodes.length - 1 : img_idx - 1;
194 |           
195 |             // console.log("display: idx " + img_idx);
196 |             // console.log("hide: idx " + old_idx);
197 |           
198 |             image_nodes[img_idx].style.display = "block";
199 |             image_nodes[old_idx].style.display = "none";
200 |           }
201 |           
202 |           img_idx++;
203 |         }
204 |         
205 |         
206 | 	    </script>
207 | 	  </head>
208 | </head>
209 | <body>'.$html_result.'
210 | <div id="progress" style="width: 900px; height: 500px;"></div>
211 | <div id="speed"    style="width: 900px; height: 500px;"></div>
212 | 
213 | <h2>Overview</h2>
214 | '.$overview_images.'
215 | 
216 | <button onclick="toggleAnimation();">play</button>
217 | </body></html>';
218 | 
219 | 
220 | 
221 | file_put_contents($folder.'/status.html', $full_html);
222 | 
223 | shell_exec("cp $pdffile status/$pdffile");
224 | echo $result."\n";
225 | 
226 | 
227 | 
228 | 


--------------------------------------------------------------------------------
/status/docx2html.xsl:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <xsl:stylesheet version="1.0"
  3 | 	xmlns="http://www.w3.org/1999/xhtml"
  4 | 	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  5 | 	xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
  6 | 	xmlns:rels="http://schemas.openxmlformats.org/package/2006/relationships"
  7 | 	xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
  8 | 	xmlns:v="urn:schemas-microsoft-com:vml">
  9 |     
 10 |   <xsl:output method="xml" omit-xml-declaration="no" indent="yes" encoding="utf-8" doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" />
 11 |   <!-- <xsl:param name="Library" select="'BCL'" /> -->
 12 |  
 13 |   <xsl:template match="/">  
 14 | 	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
 15 | 	<head></head>
 16 | 	<body>
 17 | 	<xsl:apply-templates /> 
 18 |     <!-- <xsl:apply-templates select="//Types[@Library=$Library]" mode="types" />
 19 |     <xsl:apply-templates select="//Types[@Library=$Library]" mode="index" /> -->
 20 | 	</body>
 21 | 	</html>
 22 |   </xsl:template>
 23 |   
 24 |   <xsl:template match="w:document">
 25 | 	<xsl:apply-templates select="w:body" />
 26 |   </xsl:template>
 27 |   
 28 |   <xsl:template match="w:body">
 29 | 	<xsl:apply-templates />
 30 |   </xsl:template>
 31 |   <xsl:preserve-space elements="p" />
 32 |   <xsl:preserve-space elements="body" />
 33 |   <xsl:preserve-space elements="w:body" />
 34 |   
 35 |   <xsl:template match="w:p">
 36 | 	<p><!--<xsl:value-of select="." />--><xsl:apply-templates /> </p>
 37 |   </xsl:template>
 38 |   
 39 |   <xsl:template match="w:br">
 40 | 	<br />
 41 |   </xsl:template>
 42 |   
 43 |   
 44 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='title']">
 45 | 	<h1><!--<xsl:value-of select="." />--><xsl:apply-templates mode="headline" /></h1>
 46 |   </xsl:template>
 47 |   
 48 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='author']">
 49 | 	<h4><xsl:apply-templates /></h4>
 50 |   </xsl:template>
 51 |   
 52 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='email']">
 53 | 	<h4><xsl:apply-templates /></h4>
 54 |   </xsl:template>
 55 |   
 56 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='heading1'] | w:p[w:pPr/w:pStyle/@w:val='berschrift1'] | w:p[w:pPr/w:pStyle/@w:val='berschrift1keinInhalt'] ">
 57 | 	<h2><xsl:apply-templates mode="headline" /></h2>
 58 |   </xsl:template>
 59 |   
 60 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='heading2'] | w:p[w:pPr/w:pStyle/@w:val='berschrift2']">
 61 | 	<h3><xsl:apply-templates mode="headline" /></h3>
 62 |   </xsl:template>
 63 |   
 64 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='heading3'] | w:p[w:pPr/w:pStyle/@w:val='berschrift3']">
 65 | 	<h4><xsl:apply-templates mode="headline" /></h4>
 66 |   </xsl:template>
 67 |   
 68 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='heading4'] | w:p[w:pPr/w:pStyle/@w:val='berschrift4']">
 69 | 	<h5><xsl:apply-templates mode="headline" /></h5>
 70 |   </xsl:template>
 71 |   
 72 |   <xsl:template match="w:p[w:pPr/w:pStyle/@w:val='Listenabsatz']">
 73 | 	<xsl:if test="not(preceding-sibling::w:p[1][w:pPr/w:pStyle/@w:val='Listenabsatz'])"><xsl:text disable-output-escaping="yes">&lt;ul></xsl:text></xsl:if>
 74 | 	<li><xsl:apply-templates /></li>
 75 | 	<xsl:if test="not(following-sibling::w:p[1][w:pPr/w:pStyle/@w:val='Listenabsatz'])"><xsl:text disable-output-escaping="yes">&lt;/ul></xsl:text></xsl:if>
 76 |   </xsl:template>
 77 |   
 78 |   <xsl:template match="w:r[w:rPr/w:b]"><strong><xsl:apply-templates /></strong></xsl:template>
 79 |   
 80 |   <xsl:template match="w:r[w:rPr/w:i]"><em><xsl:apply-templates /></em></xsl:template>
 81 |   
 82 |   <xsl:template match="w:instrText" />
 83 |   
 84 |   <xsl:template match="w:fldChar[@w:fldCharType='separate']"> </xsl:template>
 85 |   
 86 |   <xsl:template name="image">
 87 |     <xsl:param name="imageId">false()</xsl:param>
 88 |     <img src="{document('word/_rels/document.xml.rels')/rels:Relationships/rels:Relationship[@Id=$imageId]/@Target}.png" />
 89 | 	<!-- substring-after(, 'media/') -->
 90 |   </xsl:template>
 91 |   
 92 |   <xsl:template match="w:object">
 93 |   <!-- document('word/_rels/document.xml.rels')/rels:Relationships/rels:Relationship/@Id 
 94 |   RelIds: <xsl:value-of select="document('word/_rels/document.xml.rels')/rels:Relationships/rels:Relationship/@Id" />
 95 |   -->
 96 | 	<!--<img src="{document('word/_rels/document.xml.rels')/rels:Relationships/rels:Relationship/@Id[=./v:shape/v:imagedata/@r:id]/@Target}" />-->
 97 | 	<xsl:call-template name="image">
 98 | 	  <xsl:with-param name="imageId"><xsl:value-of select="v:shape/v:imagedata/@r:id" /></xsl:with-param>
 99 |     </xsl:call-template>
100 |   </xsl:template>
101 |   
102 |   
103 |   <!-- <xsl:template match="*" mode="types">
104 |     <xsl:for-each select="./Type">
105 |       <xsl:result-document href="{$Library}\{@FullName}.html">
106 |         <html xmlns="http://www.w3.org/1999/xhtml">
107 |         <head>
108 |           <title><xsl:value-of select="@FullName" /></title>
109 |           <style type="text/css">
110 |             .block {background-color: gray; margin: 1em; padding: 1em;}
111 |             .para, .span {}
112 |             .todo { background-color: red; margin: 1em; }
113 |             pre.code, div.code {font-family: monospace; background-color: lightgray; margin: 1em; padding: 1em;}
114 |             table, td, th { border: 1px solid black; }
115 |             .c { display: inline; font-family: monospace; }
116 |             .paramref { text-decoration: underline; }
117 |             .term { display: inline; font-family: sans-serif; font-style: italic; }
118 |           </style>
119 |         </head>
120 |         <body><h1><xsl:value-of select="@FullName" /></h1>
121 |           <xsl:call-template name="baseclass" />
122 |           <xsl:call-template name="Docs" />
123 |           <p><a href="index.html">Back to index</a></p>
124 |         </body>
125 |         </html>
126 |       </xsl:result-document>
127 |     </xsl:for-each>
128 |   </xsl:template> -->
129 | <!--  
130 |   <xsl:template match="*" mode="index">
131 |     <xsl:result-document href="{$Library}\index.html">
132 |       <html xmlns="http://www.w3.org/1999/xhtml">
133 |       <head>
134 |         <title><xsl:value-of select="@FullName" /></title>
135 |         <style type="text/css">
136 |         </style>
137 |       </head>
138 |       <body>
139 |         <h1>Classes in <xsl:value-of select="$Library" /></h1>
140 |         <ul>
141 |           <xsl:for-each select="./Type">
142 |             <li><a href="{@FullName}.html"><xsl:value-of select="@FullName" /></a></li>
143 |           </xsl:for-each>
144 |         </ul>
145 |       </body>
146 |       </html>
147 |     </xsl:result-document>
148 |   </xsl:template>
149 |   
150 | <xsl:template name="Docs" match="Docs">
151 |   <xsl:call-template name="DocsSummary" />
152 |   <xsl:call-template name="DocsRemarks" />
153 |   <xsl:call-template name="DocsExample" />
154 | </xsl:template>
155 | 
156 | <xsl:template name="DocsContent">
157 |   <xsl:param name="Content" />
158 |   <xsl:for-each select="$Content/*|$Content/text()">
159 |     <xsl:choose>
160 |       <xsl:when test="string(node-name(.))='para'">
161 |         <div class="para">
162 |           <xsl:call-template name="DocsContent">
163 |             <xsl:with-param name="Content" select="." />
164 |           </xsl:call-template>
165 |         </div>
166 |       </xsl:when>
167 |       <xsl:when test="string(node-name(.))='block'">
168 |         <div class="block">
169 |           <xsl:call-template name="DocsContent">
170 |             <xsl:with-param name="Content" select="." />
171 |           </xsl:call-template>
172 |         </div>
173 |       </xsl:when>
174 |       <xsl:when test="string(node-name(.))='code'">
175 |         <pre class="code">
176 |           <xsl:call-template name="DocsContent">
177 |             <xsl:with-param name="Content" select="." />
178 |           </xsl:call-template>
179 |         </pre>
180 |       </xsl:when>
181 |       <xsl:when test="string(node-name(.))='list'">
182 |         <xsl:choose>
183 |           <xsl:when test="string(@type) = 'table'">
184 |             <table>
185 |               <xsl:call-template name="tablecontent">
186 |                 <xsl:with-param name="Content" select="./*" />
187 |               </xsl:call-template>
188 |             </table>
189 |           </xsl:when>
190 |           <xsl:when test="string(@type='bullet')">
191 |             <ul>
192 |               <xsl:call-template name="listcontent">
193 |                 <xsl:with-param name="Content" select="./*" />
194 |               </xsl:call-template>
195 |             </ul>
196 |           </xsl:when>
197 |           <xsl:otherwise><span class="todo">LIST: <xsl:value-of select="@type" /></span></xsl:otherwise>
198 |         </xsl:choose>        
199 |       </xsl:when>
200 |       <xsl:when test="string(node-name(.))='see'">
201 |         <xsl:if test="@cref">
202 |             <xsl:call-template name="linktoclass">
203 |             <xsl:with-param name="classname" select="substring(string(@cref), 3)" />
204 |           </xsl:call-template>
205 |         </xsl:if>
206 |         <xsl:if test="@langword">
207 |           <var><xsl:value-of select="@langword" /></var>
208 |         </xsl:if>
209 |       </xsl:when>
210 |       <xsl:when test="string(node-name(.))='c'">
211 |         <div class="c"><xsl:call-template name="DocsContent">
212 |           <xsl:with-param name="Content" select="." />
213 |           </xsl:call-template>
214 |         </div>
215 |       </xsl:when>
216 |       <xsl:when test="string(node-name(.))='term'">
217 |         <div class="term"><xsl:call-template name="DocsContent">
218 |           <xsl:with-param name="Content" select="." />
219 |         </xsl:call-template></div>
220 |       </xsl:when>
221 |       <xsl:when test="string(node-name(.))='paramref'">
222 |         <span class="paramref"><xsl:value-of select="@name" /></span>
223 |       </xsl:when>
224 |       <xsl:when test="string(node-name(.))='SPAN'">
225 |         <div class="span"><xsl:call-template name="DocsContent">
226 |           <xsl:with-param name="Content" select="." />
227 |         </xsl:call-template></div>
228 |       </xsl:when>
229 |       <xsl:when test="string(node-name(.))='sup'">
230 |         <sup><xsl:call-template name="DocsContent">
231 |           <xsl:with-param name="Content" select="." />
232 |           </xsl:call-template></sup>
233 |       </xsl:when>
234 |       <xsl:when test="string(node-name(.))='superscript'">
235 |         <sup><xsl:value-of select="@term" /></sup>
236 |       </xsl:when>
237 |       <xsl:when test="string(node-name(.))=''">
238 |         <xsl:value-of select="." />
239 |       </xsl:when>
240 |       <xsl:otherwise><span class="todo"><xsl:value-of select="string(node-name(.))" /></span></xsl:otherwise>
241 |     </xsl:choose>
242 |   </xsl:for-each>
243 | </xsl:template>
244 | 
245 | 
246 | <xsl:template name="listcontent">
247 |   <xsl:param name="Content" />
248 |   <xsl:for-each select="./item">
249 |     <li><xsl:call-template name="DocsContent">
250 |       <xsl:with-param name="Content" select="." />
251 |     </xsl:call-template></li>
252 |   </xsl:for-each>
253 | </xsl:template>
254 | 
255 | <xsl:template name="tablecontent">
256 |   <xsl:param name="Content" />
257 |   <xsl:if test="exists(./listheader)">
258 |     <tr>
259 |       <xsl:for-each select="./listheader/*">
260 |         <th><xsl:call-template name="DocsContent">
261 |           <xsl:with-param name="Content" select="." />
262 |           </xsl:call-template></th>
263 |       </xsl:for-each>
264 |     </tr>
265 |   </xsl:if>
266 |   <xsl:for-each select="./item">
267 |     <tr>
268 |       <xsl:for-each select="./*">
269 |         <td><xsl:call-template name="DocsContent">
270 |           <xsl:with-param name="Content" select="." />
271 |           </xsl:call-template></td>
272 |       </xsl:for-each>
273 |     </tr>
274 |   </xsl:for-each>
275 | </xsl:template>
276 | 
277 | <xsl:template name="DocsSummary">
278 |   <xsl:if test="count(Docs/summary) > 0">
279 |     <h2>Summary</h2>
280 |     <xsl:call-template name="DocsContent">
281 |       <xsl:with-param name="Content" select="Docs/summary" />
282 |     </xsl:call-template>
283 |   </xsl:if>
284 | </xsl:template>
285 | 
286 | <xsl:template name="DocsRemarks">
287 |   <xsl:if test="count(Docs/remarks) > 0">
288 |     <h2>Remarks</h2>
289 |     <xsl:call-template name="DocsContent">
290 |       <xsl:with-param name="Content" select="Docs/remarks" />
291 |     </xsl:call-template>
292 |   </xsl:if>
293 | </xsl:template>
294 | 
295 | <xsl:template name="DocsExample">
296 |   <xsl:if test="count(Docs/example) > 0">
297 |     <h2>Example</h2>
298 |     <xsl:call-template name="DocsContent">
299 |       <xsl:with-param name="Content" select="Docs/example" />
300 |     </xsl:call-template>
301 |   </xsl:if>
302 | </xsl:template>
303 | 
304 | <xsl:template name="baseclass">
305 |   <p>Baseclass:
306 |     <xsl:call-template name="linktoclass">
307 |       <xsl:with-param name="classname" select="Base/BaseTypeName" />
308 |     </xsl:call-template>
309 |   </p>
310 | </xsl:template>
311 | 
312 | <xsl:template name="linktoclass">
313 |   <xsl:param name="classname" />
314 |   <xsl:choose>
315 |     <xsl:when test="exists(//Types[@Library=$Library]/Type[@FullName=$classname])">
316 |       <a href="{$classname}.html"><xsl:value-of select="$classname" /></a>
317 |     </xsl:when>
318 |     <xsl:otherwise>
319 |       <xsl:value-of select="$classname" />
320 |     </xsl:otherwise>
321 |   </xsl:choose>
322 | </xsl:template>-->
323 |     
324 | </xsl:stylesheet>


--------------------------------------------------------------------------------