trunk/doc/faq.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>JSCoverage - help</title>
<link rel="stylesheet" type="text/css" href="reset-fonts-grids.css">
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body>
<div id="doc3" class="yui-t5"> 
  <div id="hd"><h1><a href="./">JSCoverage</a><br><span class="tag">code coverage for JavaScript</span></h1></div>  
  <div id="bd">
    <div id="yui-main"> 
      <div id="jscoverage-main" class="yui-b">
        <h2><abbr title="Frequently Asked Questions">FAQ</abbr></h2>

        <h3>Can I use JSCoverage to measure code coverage for a page on <code>http://<var>example.com</var>/</code>?</h3>

        <p>
        In order to measure the code coverage of a page on <code>http://example.com/</code>,
        you must run <code>jscoverage</code> to create a <code>jscoverage.html</code> file on the
        <code>example.com</code> server.  You cannot use <code>http://example.org/jscoverage.html</code>
        to measure the code coverage of a page located on <code>http://example.com/</code>.
        </p>

        <p>
        The fundamental reason for this limitation is the
        <a href="http://www.mozilla.org/projects/security/components/same-origin.html">Same-Origin Policy</a>
        for untrusted JavaScript.
        </p>

        <p>
        (In fact, the current version of JSCoverage is slightly more restrictive
        than this: it requires that the JavaScript being measured reside under the
        same <strong>directory</strong> as the <code>jscoverage.html</code> file.)
        </p>

        <h3>I'm trying to load my code with the URL
        <code>file:///C:/foo/bar/jscoverage.html?foo/bar.html</code>
        and I'm getting all kinds of JavaScript errors.</h3>

        <p>
        Internet Explorer 6 seems to have problems with a <code>file:</code> URL
        that has a query string with a slash in it.
        </p>
        <p>
        As a workaround:
        </p>
        <ul class="list">
        <li>Place your files on a web server instead of loading them from the file system.
            (<code>http:</code> URLs work fine.)
        <li>Do not use a query string; enter your URL in the "URL" field in the "Browser" tab.
        <li>Rearrange your directory structure so that <code>bar.html</code>
            ends up in the same directory as <code>jscoverage.html</code>; then
            you can use the URL
            <code>file:///C:/foo/bar/jscoverage.html?bar.html</code>
            with no slash in the query string.
        <li>Use a different browser.  (IE 7 seems to work.)
        </ul>

        <h3>JSCoverage changes my cursor to a busy cursor, and it never changes back!</h3>

        <p>
        Certain browsers (<i>e. g</i>., Internet Explorer 6, Opera, Safari) have trouble changing
        the cursor.  Try moving the mouse and your cursor should change back to normal.
        </p>

        <p>
        See <a href="http://groups.google.com/group/Google-Web-Toolkit/browse_thread/thread/631908bd63241136/783c307480f95d8c">this discussion</a> for more information.
        </p>

        <h3>JSCoverage hangs sometimes when rendering the coverage report.</h3>

        <p>
        With Internet Explorer 6 (I think I see a pattern here), garbage collection can cause performance problems.
        (More information <a href="http://ajaxian.com/archives/garbage-collection-in-ie6">here</a>.)
        </p>

        <h3>Can JSCoverage be used with <a href="http://www.jsunit.net/">JsUnit</a>?</h3>

        <p>
        It is necessary to run JSCoverage in <dfn>inverted mode</dfn>.  You will have to
        modify JsUnit to launch JSCoverage.
        </p>

        <p>
        See the directory <code>doc/example-jsunit</code> for an example. It
        contains a copy of JsUnit version 2.2alpha11, with the file
        <code>jsunit/app/main-data.html</code> slightly modified to add a button
        which launches JSCoverage.  It also contains a simple unit test file <code>test.html</code>.  You
        can instrument this example as follows:
        </p>

<pre>
jscoverage --no-instrument=jsunit doc/example-jsunit doc/instrumented-jsunit
</pre>

       <p>
       You can then run the <code>test.html</code> file in JsUnit's <code>jsunit/testRunner.html</code>.
       The simplest way to do this is probably to copy the contents of <code>doc/instrumented-jsunit</code>
       to the root of a web server and then access the URL
       </p>

<pre>
http://127.0.0.1/jsunit/testRunner.html?testPage=http://127.0.0.1/test.html&amp;autoRun=true
</pre>

      <p>
      After the test suite has been run, click on the "Coverage report" button
      to get a coverage report.
      </p>

      </div>
    </div> 
    <div id="jscoverage-sidebar" class="yui-b">
      <ul>
      <li><a href="./">Home</a>
      <li><a href="news.html">News</a> <a href="http://siliconforks.com/jscoverage/news.xml" type="application/rss+xml" title="RSS feed for JSCoverage"><img src="feed-icon-14x14.png" alt="RSS feed"></a>
      <li><a href="manual.html">Documentation</a>
      <li><a href="demo.html">Demo</a>
      <li><a href="download.html">Download</a>
      <li>FAQ
      <li><a href="help.html">Help</a>
      <li><a href="license.html">License</a>
      <li><a href="links.html">Links</a>
      </ul>
    </div> 
  </div>  
  <div id="ft">
    <address>
      Copyright &copy; 2007 siliconforks.com<br>
      Last updated August 26, 2007<br>
      <a href="mailto:jscoverage@siliconforks.com">jscoverage@siliconforks.com</a>
    </address>
  </div>  
</div>
</body>
</html>
1	siliconforks	29	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2			<html>
3			<head>
4			<title>JSCoverage - help</title>
5			<link rel="stylesheet" type="text/css" href="reset-fonts-grids.css">
6			<link rel="stylesheet" type="text/css" href="style.css">
7			</head>
8			<body>
9			<div id="doc3" class="yui-t5">
10			<div id="hd"><h1><a href="./">JSCoverage</a><br><span class="tag">code coverage for JavaScript</span></h1></div>
11			<div id="bd">
12			<div id="yui-main">
13			<div id="jscoverage-main" class="yui-b">
14			<h2><abbr title="Frequently Asked Questions">FAQ</abbr></h2>
15
16	siliconforks	65	<h3>Can I use JSCoverage to measure code coverage for a page on <code>http://<var>example.com</var>/</code>?</h3>
17
18			<p>
19			In order to measure the code coverage of a page on <code>http://example.com/</code>,
20			you must run <code>jscoverage</code> to create a <code>jscoverage.html</code> file on the
21			<code>example.com</code> server. You cannot use <code>http://example.org/jscoverage.html</code>
22			to measure the code coverage of a page located on <code>http://example.com/</code>.
23			</p>
24
25			<p>
26			The fundamental reason for this limitation is the
27			<a href="http://www.mozilla.org/projects/security/components/same-origin.html">Same-Origin Policy</a>
28			for untrusted JavaScript.
29			</p>
30
31			<p>
32			(In fact, the current version of JSCoverage is slightly more restrictive
33			than this: it requires that the JavaScript being measured reside under the
34			same <strong>directory</strong> as the <code>jscoverage.html</code> file.)
35			</p>
36
37	siliconforks	29	<h3>I'm trying to load my code with the URL
38			<code>file:///C:/foo/bar/jscoverage.html?foo/bar.html</code>
39			and I'm getting all kinds of JavaScript errors.</h3>
40
41			<p>
42			Internet Explorer 6 seems to have problems with a <code>file:</code> URL
43			that has a query string with a slash in it.
44			</p>
45			<p>
46			As a workaround:
47			</p>
48			<ul class="list">
49			<li>Place your files on a web server instead of loading them from the file system.
50			(<code>http:</code> URLs work fine.)
51			<li>Do not use a query string; enter your URL in the "URL" field in the "Browser" tab.
52			<li>Rearrange your directory structure so that <code>bar.html</code>
53			ends up in the same directory as <code>jscoverage.html</code>; then
54			you can use the URL
55			<code>file:///C:/foo/bar/jscoverage.html?bar.html</code>
56			with no slash in the query string.
57			<li>Use a different browser. (IE 7 seems to work.)
58			</ul>
59
60			<h3>JSCoverage changes my cursor to a busy cursor, and it never changes back!</h3>
61
62			<p>
63			Certain browsers (<i>e. g</i>., Internet Explorer 6, Opera, Safari) have trouble changing
64			the cursor. Try moving the mouse and your cursor should change back to normal.
65			</p>
66
67			<p>
68	siliconforks	41	See <a href="http://groups.google.com/group/Google-Web-Toolkit/browse_thread/thread/631908bd63241136/783c307480f95d8c">this discussion</a> for more information.
69	siliconforks	29	</p>
70
71			<h3>JSCoverage hangs sometimes when rendering the coverage report.</h3>
72
73			<p>
74			With Internet Explorer 6 (I think I see a pattern here), garbage collection can cause performance problems.
75			(More information <a href="http://ajaxian.com/archives/garbage-collection-in-ie6">here</a>.)
76			</p>
77
78	siliconforks	41	<h3>Can JSCoverage be used with <a href="http://www.jsunit.net/">JsUnit</a>?</h3>
79
80			<p>
81			It is necessary to run JSCoverage in <dfn>inverted mode</dfn>. You will have to
82			modify JsUnit to launch JSCoverage.
83			</p>
84
85			<p>
86			See the directory <code>doc/example-jsunit</code> for an example. It
87			contains a copy of JsUnit version 2.2alpha11, with the file
88			<code>jsunit/app/main-data.html</code> slightly modified to add a button
89			which launches JSCoverage. It also contains a simple unit test file <code>test.html</code>. You
90			can instrument this example as follows:
91			</p>
92
93			<pre>
94			jscoverage --no-instrument=jsunit doc/example-jsunit doc/instrumented-jsunit
95			</pre>
96
97			<p>
98			You can then run the <code>test.html</code> file in JsUnit's <code>jsunit/testRunner.html</code>.
99			The simplest way to do this is probably to copy the contents of <code>doc/instrumented-jsunit</code>
100			to the root of a web server and then access the URL
101			</p>
102
103			<pre>
104	siliconforks	55	http://127.0.0.1/jsunit/testRunner.html?testPage=http://127.0.0.1/test.html&autoRun=true
105	siliconforks	41	</pre>
106
107			<p>
108			After the test suite has been run, click on the "Coverage report" button
109			to get a coverage report.
110			</p>
111
112	siliconforks	29	</div>
113			</div>
114			<div id="jscoverage-sidebar" class="yui-b">
115			<ul>
116			<li><a href="./">Home</a>
117			<li><a href="news.html">News</a> <a href="http://siliconforks.com/jscoverage/news.xml" type="application/rss+xml" title="RSS feed for JSCoverage"><img src="feed-icon-14x14.png" alt="RSS feed"></a>
118			<li><a href="manual.html">Documentation</a>
119			<li><a href="demo.html">Demo</a>
120			<li><a href="download.html">Download</a>
121			<li>FAQ
122			<li><a href="help.html">Help</a>
123			<li><a href="license.html">License</a>
124			<li><a href="links.html">Links</a>
125			</ul>
126			</div>
127			</div>
128			<div id="ft">
129			<address>
130			Copyright © 2007 siliconforks.com<br>
131	siliconforks	43	Last updated August 26, 2007<br>
132	siliconforks	29	<a href="mailto:jscoverage@siliconforks.com">jscoverage@siliconforks.com</a>
133			</address>
134			</div>
135			</div>
136			</body>
137			</html>