From 9eaeb6d523f9dccab792802c2cdb0c6735f3ed5d Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Fri, 27 Sep 2013 22:33:28 +0200
Subject: document all json fields

---
 cgi/index.pl               |  2 +-
 cgi/templates/main.html.ep | 21 ++++++++++-----------
 2 files changed, 11 insertions(+), 12 deletions(-)

diff --git a/cgi/index.pl b/cgi/index.pl
index 4388833..34edc6f 100644
--- a/cgi/index.pl
+++ b/cgi/index.pl
@@ -13,7 +13,7 @@ use Travel::Status::DE::VRR;
 no warnings 'uninitialized';
 no if $] >= 5.018, warnings => "experimental::smartmatch";
 
-our $VERSION = qx{git describe --dirty} || '0.06';
+our $VERSION = qx{git describe --dirty} || '0.07';
 chomp $VERSION;
 
 my %default = (
diff --git a/cgi/templates/main.html.ep b/cgi/templates/main.html.ep
index e042e4c..7a8c38f 100644
--- a/cgi/templates/main.html.ep
+++ b/cgi/templates/main.html.ep
@@ -75,29 +75,28 @@ height="<%= $height * 5 %>" width="<%= $width * 5 %>"></iframe>
 <%= $city %> <%= $stop %></a>
 </p>
 <p>
+Data is cached for 1 minute: JSON format:
+<ul>
+<li>error: err string if an error occured, otherwise null</li>
+<li>preformatted: strings used by the PNG / HTML frontend</li>
+<li>raw:
 % if (param('backend') and param('backend') eq 'db') {
-The raw data consists of serialized
+serialized
 <a href="http://finalrewind.org/projects/Travel-Status-DE-DeutscheBahn/">
 Travel::Status::DE::DeutscheBahn</a>-objects, see the
 <a href="http://man.finalrewind.org/3/Travel-Status-DE-DeutscheBahn-Result/">::Result</a>
-documentation.
+documentation
 % }
 % else {
-The raw data consists of serialized
+serialized
 <a href="http://finalrewind.org/projects/Travel-Status-DE-VRR/">
 Travel::Status::DE::VRR</a>-objects, see the
 <a href="http://man.finalrewind.org/3/Travel-Status-DE-VRR-Result/">::Result</a>
 and
 <a href="http://man.finalrewind.org/3/Travel-Status-DE-VRR-Line/">::Line</a>
-documentation.
+documentation
 % }
-</p>
-<p>
-Notes:
-<ul>
-<li>data is cached for 1 minute</li>
-<li>preformatted contains the string used by the PNG / HTML frontend</li>
-<li>if an error occured, the error field is non-null</li>
+</li>
 </ul>
 </p>
 % }
-- 
cgit v1.2.3