blob: 1d57d49bba69b2aba772a5bc91e986fdab8f6599 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<title>Jarmon Help File</title>
<h1>Jarmon User Guide</h1>
<p>Jarmon is a browser based graph rendering system.
<h2>Contents</h2>
<ol>
<li><a href="#browser-compatibility">Browser Compatibility</a></li>
<li><a href="#api-documentation">API documentation</a></li>
<li><a href="#release-process">Release process and tools</a></li>
</ol>
<h2 id="browser-compatibility">Browser Compatibility</h2>
<p>Jarmon depends upon the <a href="http://code.google.com/p/flot/">Flot
graphing library</a> which makes use of the
<a href="http://www.w3.org/TR/html5/the-canvas-element.html">HTML5 canvas
element</a>. The canvas element is only supported in certain web browsers.
<table>
<tr><th>Browser <th>Minimum Supported Version
<tr><td>Firefox <td>3.0
<tr><td>Safari <td>3.2
<tr><td>Chrome <td>3.0
<tr><td>Opera <td>10.1
<tr><td>Internet Explorer <td>6 (see caveats below)
</table>
<h3>Internet Explorer Caveats</h3>
<dl>
<dt>Internet Explorer (<= IE8)
<dd>This version of IE does not have native support the HTML canvas (see
Internet Explorer workarounds below)
element.
<dt>Internet Explorer 9
<dd>Due to be released in late 2010 this new version of IE will provide
<a href="http://blogs.msdn.com/b/ie/archive/2010/06/23/html5-native-third-ie9-platform-preview-available-for-developers.aspx">
native canvas support</a> and will be able to render Jarmon graphs as
fast (if not faster) than other browsers.
</dl>
<h3>Internet Explorer Workarounds</h3>
<dl>
<dt>Excanvas
<dd>This is the default IE compatibility workaround. Jarmon bundles the
<a href="http://code.google.com/p/explorercanvas/">excanvas library</a>
which translates canvas api calls into VML, but this is much slower
than the native canvas support in other browsers. In the absense of
other workarounds, Jarmon will transparently use the excanvas library.
<dt>Chrome Frame
<dd><a href="http://code.google.com/chrome/chromeframe/">Chrome
Frame</a> is an IE plugin developed by Google. Once installed, it
replaces the standard IE rendering module with the more performant
Chrome rendering module.</dd>
<dd>When first visiting a Jarmon page using <= IE8, you will be
prompted with an advisory message, explaining the performance penalty of
using the standard excanvas compatibility layer.
<dd>You will be asked whether you want to Install and use Chrome Frame.
You will be presented with the following options:
<dl>
<dt>Yes
<dd>After you choose this option the message will be hidden and
you will be guided through the steps necessary to install
Chrome Frame after which you can continue to use Jarmon
normally.</dd>
<dt>Remind me later
<dd>After you choose this option, the message will be hidden
and you can continue to use Jarmon.</dd>
<dd>Your preference will be saved in a cookie and the warning
message will not re-appear for 1 month.</dd>
<dt>Never
<dd>After you choose this option, the message will be hidden
and you can continue to use Jarmon.</dd>
<dd>Your preference will be saved in a cookie and the warning
message will never re-appear (unless the preference cookie is
deleted or expires).</dd>
</dl>
</dl>
<h2 id="api-documentation">API Documentation</h2>
<p>Jarmon includes <a href="apidocs/index.html">comprehensive API
documentation</a>
<p>This API documentation is generated automatically by the release command,
but you can also build it yourself by issuing the
<code>./bin/build apidoc</code> command from within a Jarmon source tree.
The documentation will be saved in a build subfolder.</p>
<h2 id="release-process">Release Process and Tools</h2>
<p>Jarmon includes tools to automate source archive releases. First check
out the source code, then issue the
<code>./bin/build -V 10.8 release</code> command from within the source
tree.</p>
|
