woozle-scoreboard/usage.html

191 lines
5.4 KiB
HTML
Raw Normal View History

2011-11-17 17:53:49 -07:00
<!DOCTYPE html>
2011-12-07 21:47:58 -07:00
<!--
Roller Derby Scoreboard Copyright © 2011 Neale Pickett
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see
<http://www.gnu.org/licenses/>.
-->
2011-11-17 17:53:49 -07:00
<html>
<head>
<title>Using the LADD Roller Derby Scoreboard</title>
<meta charset="utf-8">
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body>
<h1>Using the LADD Roller Derby Scoreboard</h1>
2011-12-02 17:55:47 -07:00
<img src="scoreboard-explained.png" alt="Annotated scoreboard"
style="border: solid black 2px;">
2011-11-17 17:53:49 -07:00
2011-12-07 21:47:58 -07:00
<h1>Setup</h1>
2011-11-17 17:53:49 -07:00
<ul>
<li>
2011-12-02 17:55:47 -07:00
When the state indicator reads "Setup", you can click on almost
2011-11-17 17:53:49 -07:00
anything to change it.
</li>
<li>
2011-12-07 21:47:58 -07:00
Set the logo before you change the team name.
2011-11-17 17:53:49 -07:00
</li>
<li>
2011-12-07 21:47:58 -07:00
If your team's logo and name isn't in the list,
2011-12-07 22:04:22 -07:00
please <a href="mailto:neale&#64;woozle.org">mail them to me</a>
and I will add them.
2011-11-17 17:53:49 -07:00
<li>
2011-12-07 21:47:58 -07:00
Reload the page (click "Reload" or type F5) to get back to setup
mode. Scores, timeouts, and period clock time are all saved.
2011-11-17 17:53:49 -07:00
</li>
<li>
2011-12-07 22:04:22 -07:00
Type Space Bar or click the jam clock to begin the first jam.
2011-11-17 17:53:49 -07:00
</li>
2011-12-07 21:47:58 -07:00
</ul>
<h1>Running Jams</h1>
<ul>
2011-11-17 17:53:49 -07:00
<li>
2011-12-07 21:47:58 -07:00
Press Space Bar or click the jam clock to switch between 2:00
jams and 0:30 rotations.
2011-12-02 17:55:47 -07:00
</li>
<li>
2011-12-07 21:47:58 -07:00
Type "A" or "B" to add points to a team's score. You can also
click a score to add a point.
2011-12-02 17:55:47 -07:00
</li>
<li>
2011-12-07 21:47:58 -07:00
Type "Shift+A" or "Shift+B" to remove points from a team's
score. You can also click a team logo to remove a point.
2011-11-17 17:53:49 -07:00
</li>
</ul>
2011-12-07 21:47:58 -07:00
<h1>Timeouts</h1>
2011-11-17 17:53:49 -07:00
2011-12-07 21:47:58 -07:00
<ul>
<li>
Type "T" or click the period clock to enter into a timeout.
</li>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<li>
Click a team's timeout count to remove one from it. If it's at
0, click it to reset it to 3.
</li>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<li>
Click the period clock during a timeout to change the time left
in the period.
</li>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<li>
Type Space Bar or click the jam clock to exit timeout mode and
start the next jam.
</li>
</ul>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<h1>Periods</h1>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<ul>
<li>
Go into Timeout mode to re-set the period clock to 30:00. Click
it to change it to a different time.
</li>
<li>
Click the period indicator to cycle between "Period 1", "Break",
and "Period 2".
</li>
</ul>
2011-12-02 17:55:47 -07:00
2011-12-07 21:47:58 -07:00
<h1>Other cases</h1>
2011-12-02 17:55:47 -07:00
<dl>
2011-12-07 21:47:58 -07:00
<dt>Halftime / Double-header break</dt>
2011-12-02 17:55:47 -07:00
<dd>
2011-12-07 21:47:58 -07:00
<ol>
<li>Type "T" to enter timeout mode.</li>
<li>Click the period indicator until it says "Break"</li>
<li>Click the period clock.</li>
<li>Enter the duration of halftime.</li>
<li>Type Space Bar to start counting down.</li>
<li>It's okay to let the jam clock reach 0:00.</li>
</ol>
2011-12-02 17:55:47 -07:00
</dd>
2011-12-07 21:47:58 -07:00
<dt>20-minute periods</dt>
2011-12-02 17:55:47 -07:00
<dd>
2011-12-07 21:47:58 -07:00
<ol>
<li>During setup or timeout, click the period clock.</li>
<li>Enter "20:00" for the new time.</li>
<li>Click the period indicator until it displays the
appropriate period</li>
</ol>
2011-12-02 17:55:47 -07:00
</dd>
</dl>
2011-11-17 17:53:49 -07:00
<h1>If the browser exits</h1>
<p>
Shit happens. So every second, the scoreboard saves its state to the
browser's long-term storage using the
HTML5 <code>localStorage</code> object. The following information
is stored, and will come back the way it was when the browser exited:
</p>
<ul>
<li>Period clock time</li>
<li>Team names</li>
<li>Team logo URLs</li>
<li>Team scores</li>
</ul>
<p>
It is a good idea to verify that your browser actually stores this
information around before you run a bout, by starting a pretend
jam, exiting, then re-opening.
</p>
<h1>Customizing the display</h1>
<p>
The scoreboard is written in HTML5, CSS, and JavaScript. If you'd
like to try your hand at graphic design, feel encouraged to do
so. Just remember to keep the <code>onclick</code>
and <code>id</code> attributes in elements that have them, and
everything should continue to work.
</p>
<p>
If you come up with a new design, or code improvements, I'd love
to see it!
</p>
<h1>If you have problems</h1>
<p>
If something goes wrong, please email me (link below) with as much
detail as you can remember, and I'll try to fix it for you and
everybody else. For example:
</p>
<blockquote>
<p>
I clicked the period timer during a timeout and the Team A logo
2011-12-07 22:04:22 -07:00
turned into a photo of a burrito.
2011-11-17 17:53:49 -07:00
</p>
</blockquote>
<h1>Enjoy!</h1>
<address>Neale Pickett <a href="mailto:neale&#64;woozle.org">&lt;neale&#64;woozle.org&gt;</a></address>
</body>
</html>