Skip to content

Commit 8542a6b

Browse files
bpollackbpollack
committed
fix typos in README and provide better documentation
1 parent fa011ba commit 8542a6b

1 file changed

Lines changed: 110 additions & 65 deletions

File tree

‎README.md‎

Lines changed: 110 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,110 @@
1-
#Solari Board
2-
![](https://trello-attachments.s3.amazonaws.com/51bf2a13808218916c006928/51f02c885eee4b1708001f67/2c081fd8d5fcf4cb505392784667372e/genericBoard.PNG)
3-
4-
5-
Fog Creek has used its [Big Board](http://blog.fogcreek.com/big-board-having-fun-with-data/) for close to three years...and now you can have your own!
6-
7-
The Solari Board jQuery application will accept any JSON payload. The support team at Fog Creek feeds in tech call information from FogBugz, but the possibilities are limitless!
8-
9-
The solari board assumes a json structure in the following format:
10-
11-
[
12-
{'sDate':'today','sTime':'13:30','sDeparture':'foo@example.com','nStatus':1,'nTrack':17, 'fLight':true},
13-
{'sDate':'yesterday','sTime':'16:00','sDeparture':'bar@example.com','nStatus':2,'nTrack':19, 'fLight':false},
14-
{'sDate':'July 8th, 2013','sTime':'16:30','sDeparture':'baz@example.com','nStatus':2,'nTrack':23, 'fLight':false}
15-
]
16-
17-
18-
#How do I use it?
19-
1. Include the following lines in your html:
20-
21-
<!-- Fonts -->
22-
<link href='https://fonts.googleapis.com/css?family=Kelly+Slab' rel='stylesheet' type='text/css'>
23-
<link href='https://fonts.googleapis.com/css?family=Lato' rel='stylesheet' type='text/css'>
24-
<link href='https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz' rel='stylesheet' type='text/css'>
25-
26-
<!-- jQuery, transit (for animations), date.js and the solari board -->
27-
<script type="text/javascript" src="js/jquery.min.js"></script>
28-
<script type="text/javascript" src="js/jquery.transit.min.js"></script>
29-
<script type="text/javascript" src="js/date.js"></script>
30-
<script type="text/javascript" src="js/solari.js"></script>
31-
32-
<!-- CSS -->
33-
<link rel="stylesheet" type="text/css" href="css/solari.css" />
34-
35-
<!-- Audio -->
36-
<audio src="audio/solari.mp3" id='solari-audio'>
37-
Your browser does not support the audio element.
38-
</audio>
39-
40-
- Add the following script to your webpage's head:
41-
42-
<script>
43-
$(document).ready(function() {
44-
//remove the div parameter to append directly to body
45-
addSolariBoard("#myDIv");
46-
});
47-
</script>
48-
49-
- Point the board to the script that will feed it json
50-
51-
$.post('../example/postJson.py', //replace this with your own script
52-
53-
Currently, Google Chrome and Internet Explorer are the only supported browsers. This is due to an issue in animating the css property 'backgroundPositionY' on other browsers.
54-
55-
##Additional Configuration and Example
56-
- Toggle "status_override" in solari.js to have the board automatically change the status column using time and date due.
57-
- The sDate field takes any [date.js](https://code.google.com/p/datejs/wiki/APIDocumentation#parse) parsable string (e.g. "today", "next monday")
58-
- The included example is a python script that will connect to a FogBugz installation through the [xml api](https://developers.fogbugz.com/default.asp?W199). Just place all files and folders onto a python enabled server (you may need to edit the first line of postJson.py to point to your own python installation). To use your own, edit fbsettings.py with your URL and[ token](http://fogbugz.stackexchange.com/questions/900/how-do-i-get-an-xml-api-token)
59-
60-
![FogBugz Solari Board](https://trello-attachments.s3.amazonaws.com/51bf2a13808218916c006928/51f02c885eee4b1708001f67/1b1ee7b798d88a6c39cf320d28146b36/fogbgzedition.PNG)
61-
62-
##Copyright
63-
Copyright © 2013 Fog Creek Software, Inc. All rights reserved.
64-
###Licensing
65-
The Solari Board is licensed under the [MIT](http://opensource.org/licenses/mit-license.php) license.
1+
#Solari Board
2+
![](https://trello-attachments.s3.amazonaws.com/51bf2a13808218916c006928/51f02c885eee4b1708001f67/2c081fd8d5fcf4cb505392784667372e/genericBoard.PNG)
3+
4+
Fog Creek has used its [Big Board](http://blog.fogcreek.com/big-board-having-fun-with-data/)
5+
for close to three years...and now you can have your own!
6+
7+
The Solari Board jQuery application will accept JSON from any source. The support team at Fog Creek
8+
feeds in tech call information from FogBugz, but the possibilities are limitless!
9+
10+
The application expects a JSON array filled with objects that have the
11+
following properties:
12+
13+
* `sDate`: the day of the appointment. The Solari board can handle values
14+
like `yesterday` or `today`.
15+
* `sDeparture`: an arbitrary string; on our board, it's the email address of
16+
the support technition who has the support call.
17+
* `nStatus`: allows you to set the status to either "All Aboard" (`nStatus
18+
= 1`) or "On Time" (`nStatus = 2`).
19+
* `nTrack`: an arbitrary integer between 0 and 99; we use it to indicate
20+
which extension the call should be on, but you can use it for whatever
21+
purpose you want.
22+
* `fLight`: should be set to `true` if you want the lightbulb by that row
23+
illuminated, and `false` otherwise.
24+
25+
Here's an example:
26+
27+
[
28+
{'sDate': 'today',
29+
'sTime': '13:30',
30+
'sDeparture': 'foo@example.com',
31+
'nStatus': 1,
32+
'nTrack': 17,
33+
'fLight': true},
34+
{'sDate': 'yesterday',
35+
'sTime': '16:00',
36+
'sDeparture': 'bar@example.com',
37+
'nStatus': 2,
38+
'nTrack': 19,
39+
'fLight':false},
40+
{'sDate': 'July 8th, 2013',
41+
'sTime': '16:30',
42+
'sDeparture': 'baz@example.com',
43+
'nStatus': 2,
44+
'nTrack': 23,
45+
'fLight':false}
46+
]
47+
48+
49+
#How do I use it?
50+
51+
It's simple!
52+
53+
1. Include the following lines in your HTML:
54+
55+
<!-- Fonts -->
56+
<link href='https://fonts.googleapis.com/css?family=Kelly+Slab' rel='stylesheet' type='text/css'>
57+
<link href='https://fonts.googleapis.com/css?family=Lato' rel='stylesheet' type='text/css'>
58+
<link href='https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz' rel='stylesheet' type='text/css'>
59+
60+
<!-- jQuery, transit (for animations), date.js and the solari board -->
61+
<script type="text/javascript" src="js/jquery.min.js"></script>
62+
<script type="text/javascript" src="js/jquery.transit.min.js"></script>
63+
<script type="text/javascript" src="js/date.js"></script>
64+
<script type="text/javascript" src="js/solari.js"></script>
65+
66+
<!-- CSS -->
67+
<link rel="stylesheet" type="text/css" href="css/solari.css" />
68+
69+
<!-- Audio -->
70+
<audio src="audio/solari.mp3" id='solari-audio'>
71+
Your browser does not support the audio element.
72+
</audio>
73+
74+
2. Add the following script to your webpage's head:
75+
76+
<script>
77+
$(document).ready(function() {
78+
//remove the div parameter to append directly to body
79+
addSolariBoard("#myDIv");
80+
});
81+
</script>
82+
83+
3. Point the board to the script that will feed it json
84+
85+
$.post('../example/postJson.py') // replace this with your own script
86+
87+
Currently, Google Chrome and Internet Explorer are the only supported browsers.
88+
This is due to an issue in animating the CSS property `backgroundPositionY` on
89+
other browsers. We'd welcome patches that help resolve this issue.
90+
91+
##Additional Configuration and Example
92+
- Toggle `status_override` in `solari.js` to have the board automatically change the
93+
status column using time and date due.
94+
- The `sDate` field takes any
95+
[date.js](https://code.google.com/p/datejs/wiki/APIDocumentation#parse) parsable string
96+
(e.g. `today`, `next monday`)
97+
- The included example is a Python script that will connect to a FogBugz installation through
98+
the [xml api](https://developers.fogbugz.com/default.asp?W199). Just place all files and
99+
folders onto a Python-enabled CGI server, then `fbsettings.py` with your URL and
100+
[FogBugz token](http://fogbugz.stackexchange.com/questions/900/how-do-i-get-an-xml-api-token).
101+
102+
![FogBugz Solari Board](https://trello-attachments.s3.amazonaws.com/51bf2a13808218916c006928/51f02c885eee4b1708001f67/1b1ee7b798d88a6c39cf320d28146b36/fogbgzedition.PNG)
103+
104+
##Copyright
105+
106+
Copyright © 2013 Fog Creek Software, Inc. All rights reserved.
107+
108+
###Licensing
109+
110+
The Solari Board is licensed under the [MIT](http://opensource.org/licenses/mit-license.php) license.

0 commit comments

Comments
 (0)