Merge pull request #41 from bluesmoon/master

Documentation updates

README.md

@@ -10,9 +10,9 @@ init() method.
 documentation is in the docs/ directory, it's all HTML, so your best bet is to check it out
 and view it locally, though it works best through a web server (you'll need cookies).
 
-An online version of the docs is here: http://yahoo.github.com/boomerang/doc/
+An online version of the docs is here: http://lognormal.github.com/boomerang/doc/
 
-The latest code and docs is available on http://github.com/yahoo/boomerang/
+The latest code and docs is available on http://github.com/lognormal/boomerang/
 
-Discussions are best done using github issues at https://github.com/yahoo/boomerang/issues
+Discussions are best done using github issues at https://github.com/lognormal/boomerang/issues
 You'll need a github account to participate.

doc/api/BOOMR.html

@@ -31,6 +31,20 @@ <h2 id="properties">Properties</h2>
 </p>
 </dd>
 
+<dt>t_start</dt>
+<dd>
+<p>
+The timestamp when the boomerang code showed up on the page.
+</p>
+</dd>
+
+<dt>t_end</dt>
+<dd>
+<p>
+The timestamp when the boomerang code finished loading.  Note, this will only be set if you used <code>make</code> to make a combined version of boomerang.
+</p>
+</dd>
+
 <dt>plugins</dt>
 <dd>
 <p>
@@ -339,6 +353,18 @@ <h3>Callback</h3>
 </p>
 </dd>
 
+<dt>visibility_changed</dt>
+<dd>
+<p>
+Fired if the page's visibility state changes.  Currently only supported on IE10 and Chrome.
+</p>
+<h3>Callback</h3>
+<p>
+No additional event data is passed to the callback function.  Any callback data is passed as specified in
+the <code>subscribe()</code> method.
+</p>
+</dd>
+
 <dt>before_beacon</dt>
 <dd>
 <p>
@@ -372,7 +398,7 @@ <h2 id="beacon">Beacon Parameters</h2>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/BOOMR.utils.html

@@ -163,7 +163,7 @@ <h3>Returns</h3>
 </dl>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/BW.html

@@ -147,7 +147,7 @@ <h2 id="beacon">Beacon Parameters</h2>
 
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/DNS.html

@@ -89,7 +89,7 @@ <h2 id="beacon">Beacon Parameters</h2>
 </dl>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/RT.html

@@ -113,7 +113,7 @@ <h3>Note</h3>
 </p>
 </dd>
 
-<dt>endTimer(sName, nValue)</dt>
+<dt>endTimer(sName, [nValue])</dt>
 <dd>
 <p>
 Stops the timer named <code>sName</code>.  It is not necessary for the timer to have been started
@@ -233,7 +233,7 @@ <h2 id="beacon">Beacon Parameters</h2>
 
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/index.html

@@ -31,7 +31,7 @@ <h2>extra plugins</h2>
 </ul>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/ipv6.html

@@ -107,7 +107,7 @@ <h2 id="beacon">Beacon Parameters</h2>
 </dl>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>

doc/api/navtiming.html

@@ -87,7 +87,8 @@ <h2 id="beacon">Beacon Parameters</h2>
 <tr><td><code>nt_res_end</code></td><td><code>window.performance.timing.responseEnd</code></td></tr>
 <tr><td><code>nt_domloading</code></td><td><code>window.performance.timing.domLoading</code></td></tr>
 <tr><td><code>nt_domint</code></td><td><code>window.performance.timing.domInteractive</code></td></tr>
-<tr><td><code>nt_domcontloaded</code></td><td><code>window.performance.timing.domContentLoaded</code></td></tr>
+<tr><td><code>nt_domcontloaded_st</code></td><td><code>window.performance.timing.domContentLoadedEventStart</code></td></tr>
+<tr><td><code>nt_domcontloaded_end</code></td><td><code>window.performance.timing.domContentLoadedEventEnd</code></td></tr>
 <tr><td><code>nt_domcomp</code></td><td><code>window.performance.timing.domComplete</code></td></tr>
 <tr><td><code>nt_load_st</code></td><td><code>window.performance.timing.loadEventStart</code></td></tr>
 <tr><td><code>nt_load_end</code></td><td><code>window.performance.timing.loadEventEnd</code></td></tr>
@@ -97,12 +98,12 @@ <h2 id="beacon">Beacon Parameters</h2>
 </table>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 </body>
 </html>
 <!--
-    Copyright (c) 2011, Yahoo! Inc.  All rights reserved.
+    Copyright (c) Buddy Brewer.  All rights reserved.
     Copyrights licensed under the BSD License. See the accompanying LICENSE.txt file for terms.
 -->

doc/community.html

@@ -15,14 +15,14 @@ <h1>boomerang community</h1>
 
 <h2>Source code</h2>
 <p>
-The source code is on github at <a href="https://github.com/yahoo/boomerang">github.com/yahoo/boomerang</a>.  Feel
-free to fork it and contribute to it.  You can also get a <a href="http://github.com/yahoo/boomerang/archives/master">tarball
+The source code is on github at <a href="https://github.com/lognormal/boomerang">github.com/lognormal/boomerang</a>.  Feel
+free to fork it and contribute to it.  You can also get a <a href="http://github.com/lognormal/boomerang/archives/master">tarball
 or zip archive of the code</a>.
 </p>
 
 <h2>Bugs & Discussions</h2>
 <p>
-Use github's <a href="https://github.com/yahoo/boomerang/issues">issue tracking system</a> to report or follow bugs or to
+Use github's <a href="https://github.com/lognormal/boomerang/issues">issue tracking system</a> to report or follow bugs or to
 discuss features and get support.
 </p>
 

doc/howtos/howto-0.html

@@ -54,13 +54,19 @@ <h4>roundtrip plugin parameters</h4>
 <dt>t_done</dt> <dd><strong>[optional]</strong> Perceived load time of the page.</dd>
 <dt>t_page</dt> <dd><strong>[optional]</strong> Time taken from the head of the page to page_ready.</dd>
 <dt>t_resp</dt> <dd><strong>[optional]</strong> Time taken from the user initiating the request to the first byte of the response.</dd>
-<dt>t_other</dt> <dd><strong>[optional]</strong> Comma separated list of additional timers set by page developer.  Each timer is of the format <code>name|value</code></dd>
-<dt>t_load</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time to fetch and prerender the page.</dd>
-<dt>t_prerender</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time from start of prefetch to the actual page display.  It may only be useful for debugging.</dd>
-<dt>t_postrender</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time from prerender finish to actual page display.  It may only be useful for debugging.</dd>
+<dt>t_other</dt> <dd><strong>[optional]</strong> Comma separated list of additional timers set by page developer.  Each timer is of the format <code>name|value</code>.  The following timers may be included:
+<dl>
+	<dt>t_load</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time to fetch and prerender the page.</dd>
+	<dt>t_prerender</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time from start of prefetch to the actual page display.  It may only be useful for debugging.</dd>
+	<dt>t_postrender</dt> <dd><strong>[optional]</strong> If the page were prerendered, this is the time from prerender finish to actual page display.  It may only be useful for debugging.</dd>
+	<dt>boomerang</dt> <dd>The time it took boomerang to load up from first byte to last byte</dd>
+	<dt>boomr_fb</dt> <dd><strong>[optional</strong> The time it took from the start of page load to the first byte of boomerang.  Only included if we know when page load started.</dd>
+</dl></dd>
 <dt>r</dt> <dd>URL of page that set the start time of the beacon.</dd>
 <dt>r2</dt> <dd><strong>[optional]</strong> URL of referrer of current page.  Only set if different from <code>r</code> and <code>strict_referrer</code> has been explicitly turned off.</dd>
 <dt>rt.start</dt> <dd>Specifies where the start time came from.  May be one of <code>cookie</code> for the start cookie, <code>navigation</code> for the W3C navigation timing API, <code>csi</code> for older versions of Chrome or <code>gtb</code> for the Google Toolbar.</dd>
+<dt>rt.bstart</dt> <dd>The timestamp when boomerang showed up on the page</dd>
+<dt>rt.end</dt> <dd>The timestamp when the done() method was called</dd>
 </dl>
 
 <h4>bandwidth &amp; latency plugin</h4>
@@ -184,7 +190,7 @@ <h2>Statistical analysis of the data</h2>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-10-page#1.html

@@ -43,7 +43,7 @@ <h1>boomerang howto #10:<br>load time of a page prerendered by Google Chrome</h1
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-10-page#2.html

@@ -36,7 +36,7 @@ <h1>boomerang howto #10:<br>load time of a page prerendered by Google Chrome</h1
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-1a-page#1.html

@@ -70,7 +70,7 @@ <h2>More complex sites</h2>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-1a-page#2.html

@@ -24,7 +24,7 @@ <h1>Boomerang Howto #1a:<br>User clicks a link on a page we control and page is
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-1b-page#1.html

@@ -50,7 +50,7 @@ <h1>Boomerang Howto #1b:<br>User clicks a link on a page we control and page is
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-1b-page#2.html

@@ -25,7 +25,7 @@ <h1>Boomerang Howto #1b:<br>User clicks a link on a page we control and page is
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-2.html

@@ -55,7 +55,7 @@ <h1>Boomerang Howto #2:<br>Measure perceived performance of content loaded dynam
  </pre>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-3.html

@@ -156,7 +156,7 @@ <h2>Disabling the bandwidth check</h2>
 </pre>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-4.html

@@ -138,7 +138,7 @@ <h2>Measuring time for content loaded before boomerang</h2>
 </pre>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-5.html

@@ -100,7 +100,7 @@ <h2>Stopping the beacon</h2>
 </pre>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-6.html

@@ -221,7 +221,7 @@ <h2>All optional</h2>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-7.html

@@ -102,7 +102,7 @@ <h2>Fake beacons that do not originate from a page you own</h2>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-8.html

@@ -61,7 +61,7 @@ <h1>Boomerang Howto #8: Measure a user's DNS latency</h1>
 </p>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/howto-9.html

@@ -8,9 +8,6 @@
 <body>
 <span style="float:right;"><a href="../">All Docs</a> | <a href="index.html">Index</a></span>
 <h1>Boomerang Howto #9: Collect performance data from the Navigation Timing API</h1>
-<p>
-<strong>Note:</strong> The Navigation Timing plugin hasn't been tested.  Your help in testing it is appreciated.
-</p>
 
 <p>The W3C Navigation Timing API is an interface implemented by modern browsers that
 provides broad and deep data related to the performance of page loads.  At the time
@@ -19,7 +16,7 @@ <h1>Boomerang Howto #9: Collect performance data from the Navigation Timing API<
 <ul>
 <li>Chrome 6+</li>
 <li>Internet Explorer 9+</li>
-<li><a href="https://bugzilla.mozilla.org/show_bug.cgi?id=570341">Coming soon to Firefox</a></li>
+<li>Firefox 7+ (<strong>note</strong> that a bug in Firefox 7 and 8 reports the incorrect time for navigationStart.  Use unloadEventStart or fetchStart for a close proximation.)</li>
 </ul>
 
 <p>The navtiming.js plugin doesn't require any configuration options as it simply
@@ -61,7 +58,8 @@ <h1>Boomerang Howto #9: Collect performance data from the Navigation Timing API<
 <tr><td><code>nt_res_end</code></td><td><code>window.performance.timing.responseEnd</code></td></tr>
 <tr><td><code>nt_domloading</code></td><td><code>window.performance.timing.domLoading</code></td></tr>
 <tr><td><code>nt_domint</code></td><td><code>window.performance.timing.domInteractive</code></td></tr>
-<tr><td><code>nt_domcontloaded</code></td><td><code>window.performance.timing.domContentLoaded</code></td></tr>
+<tr><td><code>nt_domcontloaded_st</code></td><td><code>window.performance.timing.domContentLoadedStart</code></td></tr>
+<tr><td><code>nt_domcontloaded_end</code></td><td><code>window.performance.timing.domContentLoadedEnd</code></td></tr>
 <tr><td><code>nt_domcomp</code></td><td><code>window.performance.timing.domComplete</code></td></tr>
 <tr><td><code>nt_load_st</code></td><td><code>window.performance.timing.loadEventStart</code></td></tr>
 <tr><td><code>nt_load_end</code></td><td><code>window.performance.timing.loadEventEnd</code></td></tr>
@@ -70,7 +68,7 @@ <h1>Boomerang Howto #9: Collect performance data from the Navigation Timing API<
 </table>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <p id="results">

doc/howtos/index.html

@@ -30,12 +30,10 @@ <h2>HOWTO</h2>
 <h2>TODO</h2>
 <ul>
 <li><a href="../TODO.txt">TODO 1</a> &mdash; Measure a random sample of users instead of all users</li>
-<li><a href="../TODO.txt">TODO 2</a> &mdash; User types in URL/clicks a bookmark or link on a page we don't control and our page is usable when onload fires</li>
-<li><a href="../TODO.txt">TODO 2</a> &mdash; User types in URL/clicks a bookmark or link on a page we don't control and our page is usable at some developer determined point</li>
 </ul>
 
 <p class="perma-link">
-The latest code and docs is available on <a href="http://github.com/yahoo/boomerang/">github.com/yahoo/boomerang</a>
+The latest code and docs is available on <a href="http://github.com/lognormal/boomerang/">github.com/lognormal/boomerang</a>
 </p>
 
 <script src="../../boomerang.js" type="text/javascript"></script>