updates to the doc
for issue CB-1: https://issues.apache.org/jira/browse/CB-1
Biggest change was removing the test drive, and replacing
with a "User Interface" page. Re-doing all the screen
shots.
diff --git a/README.md b/README.md
index 1a98afb..6860620 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,2 @@
For more information on weinre, please visit
-[http://phonegap.github.com/weinre/](http://phonegap.github.com/weinre/)
\ No newline at end of file
+[https://github.com/callback/callback-weinre/](https://github.com/callback/callback-weinre/)
\ No newline at end of file
diff --git a/weinre.build/README.md b/weinre.build/README.md
index c4b08a4..e7a43c9 100644
--- a/weinre.build/README.md
+++ b/weinre.build/README.md
@@ -1,36 +1,29 @@
building weinre
===============================================================================
-weinre is currently built using Eclipse. You will need a fairly recent version of Eclipse with the Java IDE tooling installed to use it.
-
-weinre is made up of five Eclipse projects:
+The weinre source base consists of file folders:
- `weinre.application`
- `weinre.build`
- `weinre.doc`
- `weinre.server`
- `weinre.web`
-
-When initially loaded into Eclipse you will find many errors in the projects. This is due to the fact that libraries that weinre depends on have not yet been loaded into the workspace. To load these libraries, run the Ant script `weinre.build/build.xml` from the weinre.build directory.
-Ensure the property `USE_JAVAC` is NOT set in the personal.properties file. If this property is set, then the java files in the projects will be compiled with javac instead of being assumed to be built with Eclipse, which may cause problems since Eclipse is also compiling the java files.
+weinre was originally built using Eclipse, and still maintains Eclipse meta-data so that it can be developed in Eclipse. Each of the folders above maps into a separate project. Note however that the Eclipse-y-ness of the weinre source base is no longer maintained. Please open a bug if there are problems.
-When the Ant script completes successfully, a full build will have taken place. The various red X's another issues from Eclipse should be gone. If not:
+Before running a build, you should copy the `weinre.build/sample.personal.properties` file to the file `weinre.build/personal.properties`, and then customize that file.
-- select all projects, right click context menu/Refresh
-- use the Eclipse menu item Project/Clean ...
+weinre requires additional code to produce the final jar. These dependencies will be downloaded the first time you run a build, and then won't be downloaded for subsequent builds. You can explicitly get the dependencies by running the `weinre.build/get-vendor.xml` file in Ant, as follows:
-This should make everything right.
-
-You may want to set the Eclipse preference General/Workspace/Refresh automatically to true (checked) so you don't have to Refresh and Clean.
+ ant -f get-vendor.xml
Various transient directories in this project (weinre.build) will be created after the build. They are set to not be stored in the SCM. They include:
-- out
-- cached
-- tmp
-- vendor
-
+- `out`
+- `cached`
+- `tmp`
+- `vendor`
+
You can delete them whenever you wish, or use the `"clean"` target of the `weinre.build/build.xml` file to delete them. Deleting them will cause the build to take longer, to rebuild what you deleted.
The `weinre.build/out` directory in particular contains the final build artifacts:
@@ -38,22 +31,17 @@
- `weinre.build/out/archives/weinre-doc-{version}.zip`
contains the HTML doc for weinre
-
+
- `weinre.build/out/archives/weinre-jar-{version}.zip`
-
+
contains the platform-portable weinre.jar file
-
+
- `weinre.build/out/archives/weinre-mac-{version}.zip`
-
+
contains the Mac OS X weinre.app application
-
+
- `weinre.build/out/archives/weinre-src-{version}.zip`
-
+
contains the source of the projects (copy of what's in the SCM)
-
-To build while you are developing the weinre code, you can use the quicker-to-build `"build-dev"` target of `weinre.build/build.xml` . This will not build the jars or archives, just rebuilds the bits neccessary to run the server from the Eclipse workspace. A shell script using a Python utility is provided called `"build-continuous.sh"` which you can run and it will run the `"build-dev"` target whenever a relevant source file has changed in the workspace.
-building without eclipse
--------------------------------------------------------------------------------
-
-Ensure the property `USE_JAVAC` is set in the `personal.properties` file. If this property is set, then the java files in the projects will be compiled with javac instead of being assumed to be built with Eclipse.
+To build while you are developing the weinre code, you can use the quicker-to-build `"build-dev"` target of `weinre.build/build.xml` . This will not build the jars or archives, just rebuilds the bits necessary to run the server transient output directories.
diff --git a/weinre.build/build.xml b/weinre.build/build.xml
index 68bfcc5..e445f61 100644
--- a/weinre.build/build.xml
+++ b/weinre.build/build.xml
@@ -96,7 +96,7 @@
compile java code
============================================================ -->
- <target name="compile-java" if="USE_JAVAC">
+ <target name="compile-java" unless="USE_ECLIPSE">
<delete dir="../${PROJECT_SERVER}/bin"/>
<mkdir dir="../${PROJECT_SERVER}/bin"/>
@@ -258,15 +258,15 @@
<copy todir="${WEB}/doc" file="${OUT}/build-info.txt"/>
- <build-html name="Building" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="Home" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="Installing" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="License" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="Running" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="MultiUser" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="Security" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="TestDrive" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
- <build-html name="ChangeLog" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="Building" title="Building" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="Home" title="Home" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="Installing" title="Installing" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="License" title="License" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="Running" title="Running" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="MultiUser" title="Muli-User" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="Security" title="Security" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="UserInterface" title="User Interface" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
+ <build-html name="ChangeLog" title="ChangeLog" oDir="${WEB}/doc" iDir="../${PROJECT_DOC}"/>
<copy file="${WEB}/doc/Home.html" tofile="${WEB}/doc/index.html"/>
@@ -593,6 +593,7 @@
<macrodef name="build-html">
<attribute name="name"/>
+ <attribute name="title"/>
<attribute name="iDir"/>
<attribute name="oDir"/>
<element name="args" optional="true" implicit="true"/>
@@ -604,7 +605,7 @@
<filelist dir="@{iDir}" files="boilerplate-trailer.html.txt"/>
<filterchain>
<replacetokens>
- <token key="PAGE_NAME" value="@{name}"/>
+ <token key="PAGE_NAME" value="@{title}"/>
</replacetokens>
</filterchain>
</concat>
diff --git a/weinre.build/sample.personal.properties b/weinre.build/sample.personal.properties
index 82e22f8..22f7204 100644
--- a/weinre.build/sample.personal.properties
+++ b/weinre.build/sample.personal.properties
@@ -1,7 +1,7 @@
# ---
# weinre is available under *either* the terms of the modified BSD license *or* the
# MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
-#
+#
# Copyright (c) 2010, 2011 IBM Corporation
# ---
@@ -9,26 +9,24 @@
# example of a personal.properties file
#------------------------------------------------------------------------------
# Create a file called personal.properties in this directory, and it will
-# you to override property settings during the build.
-#
+# you to override property settings during the build.
+#
# The personal.properties file is set to not be stored in the SCM.
#------------------------------------------------------------------------------
+#------------------------------------------------------------------------------
+# your name, which will be included in the build artifacts
+#------------------------------------------------------------------------------
BUILDER: Your Name in Lights
-USE_GROWL: true
-
-USE_JAVAC: false
+#------------------------------------------------------------------------------
+# Set to anything to enable the build posting a "done" message to Growl.
+# Delete or comment out to not use Growl.
+#------------------------------------------------------------------------------
+USE_GROWL: yup
#------------------------------------------------------------------------------
-# the libraries commented out below are particularly slow to get from their
-# originating locations, and are good to cache locally. The definitions
-# override those in vendor.properties
+# Set to anything to enable compiling the Java code with Eclipse.
+# Delete or comment out to compile the Java code with javac.
#------------------------------------------------------------------------------
-
-#CACHED_LIBRARIES: file:///Users/me/Sites/weinre-cached-libraries
-
-#SWT_URL_PREFIX: ${CACHED_LIBRARIES}
-#JETTY_URL_PREFIX: ${CACHED_LIBRARIES}/jetty
-#JAVAX_SERVLET_URL_PREFIX: ${CACHED_LIBRARIES}/jetty
-#JSON4J_URL_PREFIX: ${CACHED_LIBRARIES}/wink
+#USE_ECLIPSE: yup
diff --git a/weinre.doc/Building.body.html b/weinre.doc/Building.body.html
index 401fe8d..79ab67f 100644
--- a/weinre.doc/Building.body.html
+++ b/weinre.doc/Building.body.html
@@ -1,21 +1,14 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
-<p>The source repository for weinre is maintained at
-<a href="https://github.com/phonegap/weinre">GitHub</a>.
+<p>The source repository for weinre is maintained at
+<a href="https://github.com/callback/callback-weinre">GitHub</a>.
-<p>To build the current version of <span class="weinre">weinre</span>, you will
-probably want to use Eclipse. If that's not an option, there is some
-experimental support in the main ant build script to compile the Java code
-outside of Eclipse. Explore the <tt>build.xml</tt> file to see how that's
-done.
-
-<p>At development time, <span class="weinre">weinre</span> consists of 5 Eclipse
-projects. See the file <tt>README.md</tt> in the
-<tt>weinre.build</tt> project for more instructions on
+<p>At development time, <span class="weinre">weinre</span> consists of 5
+directories / Eclipse projects. See the file <tt>README.md</tt> in the
+<tt>weinre.build</tt> directory for more instructions on
how to perform a build.
-
diff --git a/weinre.doc/ChangeLog.body.html b/weinre.doc/ChangeLog.body.html
index 432c26c..5df5dce 100644
--- a/weinre.doc/ChangeLog.body.html
+++ b/weinre.doc/ChangeLog.body.html
@@ -1,14 +1,14 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2011 IBM Corporation
-->
<!-- ======================================================================= -->
<h2>Downloads</h2>
-<p><a href="https://github.com/phonegap/weinre/downloads">https://github.com/phonegap/weinre/downloads</a>
+<p><a href="https://github.com/callback/callback-weinre/downloads">https://github.com/callback/callback-weinre/downloads</a>
<!-- ======================================================================= -->
<h2>2011/07/22 - version 1.5.0</h2>
@@ -23,22 +23,22 @@
in other browsing sessions will not be displayed until they are first opened.
<p>Clicking on a database table will dump the database contents to the panel.
-Clicking on the database itself will provide a prompter for you to run SQL
-commands against that database. For example, entering
-<tt>"select * from YourTableNameHere"</tt>
+Clicking on the database itself will provide a prompter for you to run SQL
+commands against that database. For example, entering
+<tt>"select * from YourTableNameHere"</tt>
will dump the table contents to the panel.
<li><p>Some of the console functions, like <tt>console.log()</tt>, were not handling
object arguments correctly. You should now see a an object display. For example,
-typing <tt>"window"</tt> or <tt>"console.log(window)"</tt> into the console
+typing <tt>"window"</tt> or <tt>"console.log(window)"</tt> into the console
will show you the same object display for the window.
-<li><p>The ant build script did not have the correctly-cased file names for some
+<li><p>The ant build script did not have the correctly-cased file names for some
of the files, and the build failed. This has been fixed. You should be able
to do a build on Linux, and other case-sensitive file systems.
<li><p>While weinre already removes some of the Web Inspector panels wholesale,
-there were still a number of meaningless gee-gaws on the panels that we do show.
+there were still a number of meaningless gee-gaws on the panels that we do show.
Those have been surgically removed with CSS.
</ul>
diff --git a/weinre.doc/Home.body.html b/weinre.doc/Home.body.html
index 5cf5dc2..f5ef7de 100644
--- a/weinre.doc/Home.body.html
+++ b/weinre.doc/Home.body.html
@@ -2,110 +2,106 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
-<p><span class="weinre">weinre</span> is <b>We</b>b <b>In</b>spector <b>Re</b>mote.
+<p><span class="weinre">weinre</span> is <b>WE</b>b <b>IN</b>spector <b>RE</b>mote.
Pronounced like the word "winery". Or maybe like the word "weiner". Who knows,
really.
-<p>Interesting places:
-<ul>
-<li>GitHub: <a href="https://github.com/phonegap/weinre">https://github.com/phonegap/weinre</a>
-<li>Google Group: <a href="http://groups.google.com/group/weinre">http://groups.google.com/group/weinre</a>
-<li>weinre documentation: <a href="http://phonegap.github.com/weinre">http://phonegap.github.com/weinre</a>
-<li>Google Chrome Developer Tools: <a href="http://code.google.com/chrome/devtools/docs/overview.html">http://code.google.com/chrome/devtools/docs/overview.html</a>
-</ul>
-
-<p>It's a debugger for web pages, like
+<p><span class="weinre">weinre</span> is a debugger for web pages, like
FireBug (for FireFox)
-and
+and
Web Inspector (for WebKit-based browsers), except it's designed
to work <b>remotely</b>, and in particular, to <b>allow you debug web pages
on a mobile device such as a phone</b>.
-<p>If you aren't familiar with FireBug or Web Inspector,
+<p>Interesting places to visit:
+<table>
+<tr><td>- videos at YouTube: <td><a href="http://www.youtube.com/results?search_query=weinre">http://www.youtube.com/results?search_query=weinre</a>
+<tr><td>- this documentation at GitHub: <td><a href="http://callback.github.com/callback-weinre">http://callback.github.com/callback-weinre</a>
+<tr><td>- source at GitHub: <td><a href="https://github.com/callback/callback-weinre">https://github.com/callback/callback-weinre</a>
+<tr><td>- discussion at Google Group: <td><a href="http://groups.google.com/group/weinre">http://groups.google.com/group/weinre</a>
+</table>
+
+<p>More information on <span class="weinre">weinre</span>'s big brothers, Web Inspector / Google Chrome
+Developer Tools, is available at
+<a href="http://code.google.com/chrome/devtools/docs/overview.html">Google's Chrome Dev Tools pages</a>
+and
+<a href="http://developer.apple.com/library/safari/#documentation/appleapplications/Conceptual/Safari_Developer_Guide/DebuggingYourWebsite/DebuggingYourWebsite.html">Apple's Web Inspector pages</a>.
+
+<p>If you aren't familiar with FireBug or Web Inspector,
<span class="weinre">weinre</span> isn't going to make too much sense to you.
<span class="weinre">weinre</span> reuses the user interface code from the
<a href="http://trac.webkit.org/wiki/WebInspector">Web Inspector project at WebKit</a>,
-so if you've used Safari's Web Inspector or Chrome's Developer Tools,
+so if you've used Safari's Web Inspector or Chrome's Developer Tools,
<span class="weinre">weinre</span> will be very familiar. If you're not
-familiar with Web Inspector, the link above to Google Chrome Developer Tools
-provides some documentation Real Web Inspector, which <span class="weinre">weinre</span> is based on.
+familiar with Web Inspector, the links above to Google's and Apple's documentation
+will be useful.
-<!--
-<div class="note">
-<p>NOTE: Please note that <span class="weinre">weinre</span> is still under development and
-is not fully operational.
-The current version only supports the following functionality:
+<p>Here's an example session using <span class="weinre">weinre</span>:
-<ul class="spaced">
-<li>basic console interaction, to capture <tt>console.log()</tt> messages, and
-interactively execute JavaScript in the web page
-<li>displaying the DOM in the elements panel
-</ul>
+<p><img src="images/weinre-demo.jpg">
-</div>
--->
+<p>Two screen captures are shown above. On the left is the
+<span class="weinre">weinre</span> <b>client</b> application, displaying debug
+information.
+On the right is the <b>target</b> web page, running in Mobile Safari in the iOS Simulator.
-<p>Here's what you can do with it:
+<p>In normal usage, you will be running the <b>client</b> application in a browser
+on your desktop/laptop, and running a <b>target</b> web page on your mobile device.
-<p><img src="images/gmail-green-target-client.jpg">
-
-<p>Two screen captures are shown above.
-
-<p>The screen capture on the left is from an
-iPod Touch, running the Mobile Safari app, visiting a browser-based email web site
-you may be familiar with.
-
-<p>The screen capture on the right is the from a laptop computer, running the
-<span class="weinre">weinre</span> debug client, debugging the web page on the left. The DOM being displayed
-in the elements panel is from the HTML being displayed in the web browser on the iPod Touch.
-
-<p>You might think that green background in the email client is a bit horrifying.
-It's not normally green. I made it green by executing the following JavaScript code
-in the <span class="weinre">weinre</span> console area (as you can see above):
+<p>In the session above, the debugger is display the Elements panel, with the
+embedded console expanded in the bottom third of the window. In the console
+area, we've entered two statements:
<pre>
-document.body.style.background = "green"
+document.body.style.backgroundColor
+document.body.style.backgroundColor = "pink"
</pre>
+<p>The result of running the first statement shows the value of the body's background style is not set.
+The second statement sets the body's background to pink. That horrifying pink
+background is then rendered in the <b>target</b>'s window.
+
+<p>In addition, an <tt>h1</tt> element is selected in the upper third of the
+Elements panel, which causes the side panels on the right to be filled in with
+relevant information. In this case, the matched CSS rules for that <tt>h1</tt>
+element are being shown.
+
<p>If you are familiar with WebKit's Web Inspector,
a partial list of differences between it and <span class="weinre">weinre</span>
are listed below:
<ul class="spaced">
-<li><span class="weinre">weinre</span> does not make use of any 'native' code,
+<li><span class="weinre">weinre</span> does not make use of any 'native' code,
it's all JavaScript (and currently Java code for the 'server').
-<li>Because <span class="weinre">weinre</span> doesn't use 'native' code,
+<li>Because <span class="weinre">weinre</span> doesn't use 'native' code,
it's functionality is limited. For instance, source level debug of JavaScript
-is not possible.
-
-<li>Because <span class="weinre">weinre</span> doesn't use 'native' code,
+is not <span class="strike">possible</span>
+<a href="http://lexandera.com/aardwolf/">easy</a>.
+
+<li>Because <span class="weinre">weinre</span> doesn't use 'native' code,
the debug target code will run on browsers
without specialized debug support. For instance, a browser running on your phone.
-
-<li><span class="weinre">weinre</span> supports 'remote' interaction,
-so you can run the debugger user interface on one
+
+<li><span class="weinre">weinre</span> supports 'remote' interaction,
+so you can run the debugger user interface on one
machine and can debug a web page running
on another machine. For instance, debug a web page displayed on your phone from your
laptop.
-
-<li>Because <span class="weinre">weinre</span> supports 'remote' interaction,
+
+<li>Because <span class="weinre">weinre</span> supports 'remote' interaction,
multiple debug clients can be debugging the same debug target at the same time.
<li>One thing <b>not</b> different from Web Inspector is that the debug client
-user interface only runs on WebKit-based browsers. Sorry folks.
+user interface only runs on WebKit-based browsers.
</ul>
-<p>Find out more by clicking one of the links at the top or bottom of the page
-- to see a walkthrough of
-how to use it, visit the <a href="TestDrive.html">Test Drive</a>.
-
<!-- ======================================================== -->
<h2>Supported Libraries and Platforms</h2>
@@ -127,7 +123,7 @@
<li>versions of Prototype.js before version 1.7 are not supported,
as they do not support the <tt>JSON.stringify()</tt> API correctly. You
will get an <tt>alert()</tt> in the web page you are debugging if you
-attempt to debug it with weinre and you are using an unsupported
+attempt to debug it with <span class="weinre">weinre</span> and you are using an unsupported
version of Prototype.js.
</ul>
@@ -137,7 +133,7 @@
<ul>
<li>weinre Mac application - Mac OS X 10.6 64-bit
<li>Google Chrome 8.x
-<li>Apple Safari 5.x
+<li>Apple Safari 5.x
</ul>
<h3>Platforms supported - debug target</h3>
diff --git a/weinre.doc/Installing.body.html b/weinre.doc/Installing.body.html
index a723711..b94638a 100644
--- a/weinre.doc/Installing.body.html
+++ b/weinre.doc/Installing.body.html
@@ -1,13 +1,13 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
<p><span class="weinre">weinre</span> is shipped as two archives
available at
-<a href="https://github.com/phonegap/weinre/archives/master">https://github.com/phonegap/weinre/archives/master</a>
+<a href="https://github.com/callback/callback-weinre/archives/master">https://github.com/callback/callback-weinre/archives/master</a>
<ul class="spaced">
@@ -19,6 +19,6 @@
</ul>
-<p>Install the .jar and/or Mac OS X application wherever you wish.
+<p>Install the .jar and/or Mac OS X application wherever you wish.
At runtime, the .jar file is not sensive to the directory
it is installed in, or the current directory when it's launched.
diff --git a/weinre.doc/MultiUser.body.html b/weinre.doc/MultiUser.body.html
index 460367a..065d892 100644
--- a/weinre.doc/MultiUser.body.html
+++ b/weinre.doc/MultiUser.body.html
@@ -1,12 +1,12 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
<p><span class="weinre">weinre</span> was originally designed so that each user
-that wanted to use <span class="weinre">weinre</span> would run their own
+that wanted to use <span class="weinre">weinre</span> would run their own
<span class="weinre">weinre</span> server. The system has since been enhanced
to support muliple users using the same server.
@@ -17,17 +17,17 @@
id will be used in the client and target URLs of <span class="weinre">weinre</span>
to scope your clients and targets from the clients and targets of other users.
-<p>There is no password, just an id. There is no real security here.
+<p>There is no password, just an id. There is no real security here.
The id is a secret shared between your
debug target and client, but it is sent in the clear when your target and
client connect to the server. If someone else knows your <b>id</b>, they can
connect to clients or targets you are running with that <b>id</b>.
-<p>So don't give your <b>id</b> to anyone else that you don't want to share
+<p>So don't give your <b>id</b> to anyone else that you don't want to share
with.
<p>To keep your <b>id</b>'s familar but non-guessable, you might use a string
-consisting of your typical userid, followed by a dash, followed by another
+consisting of your typical userid, followed by a dash, followed by another
string not likely to be guessed by other people.
<p>If you are paranoid, you can change your <b>id</b> every time you start
@@ -37,7 +37,7 @@
<h2>Using your id with the client</h2>
<p>Typically when start a <span class="weinre">weinre</span> client session
-by visiting a URL like
+by visiting a URL like
<pre>
http://some.server.xyz/client/
@@ -45,8 +45,8 @@
<p>To start
a client with a particular id, append the hash character (<code>#</code>) and
-the id you want to use the URL. For instance, to connect with the id
-<code>itsReallyMe</code>, launch the client with the URL
+the id you want to use the URL. For instance, to connect with the id
+<code>itsReallyMe</code>, launch the client with the URL
<pre>
http://some.server.xyz/client/#itsReallyMe
@@ -78,16 +78,16 @@
<ul class="spaced">
<li>The <span class="weinre">weinre</span> server always runs in multi-user
-mode. If you don't otherwise specify an <b>id</b>, the value of
+mode. If you don't otherwise specify an <b>id</b>, the value of
<code>anonymous</code> will be used for the <b>id</b>.
<li>The <b>id</b> is passed in the HTTP body of a POST request during the
initial connection of the target and client to the server, and is not sent
thereafter. Thus, it should remain out of view in server logs and the like,
-though it will be visible for anyone who has access to the contents of
+though it will be visible for anyone who has access to the contents of
HTTP request bodies.
-<li>There is no programmatic interface on the <span class="weinre">weinre</span>
+<li>There is no programmatic interface in <span class="weinre">weinre</span>
to list <b>id</b>'s in current use, for security reasons. From the Remote panel
of weinre, each connected client and target have their channel and id's listed,
if you can't remember what id you used with the client.
diff --git a/weinre.doc/Running.body.html b/weinre.doc/Running.body.html
index 8af91d8..6a63add 100644
--- a/weinre.doc/Running.body.html
+++ b/weinre.doc/Running.body.html
@@ -1,7 +1,7 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
@@ -19,26 +19,26 @@
<dl class="spaced">
<dt>Debug Server
-<dd>This is the HTTP server that you run from the <tt>weinre.jar</tt> file
+<dd>This is the HTTP server that you run from the <tt>weinre.jar</tt> file
or the Mac application. It's the HTTP server that's used by the
<b>Debug Client</b> and <b>Debug Target</b>.
<dt>Debug Client
-<dd>This is the Web Inspector user interface; the web page which
-displays the Elements and Console panels, for instance.
+<dd>This is the Web Inspector user interface; the web page which
+displays the Elements and Console panels, for instance.
<dt>Debug Target
<dd>This is your web page that you want to debug. This
name (Debug Target) is also used to refer to the machine
running the browser displaying the web page. Since a design
-point of <span class="weinre">weinre</span> is to allow
+point of <span class="weinre">weinre</span> is to allow
debugging applications on mobile devices, the debug
target, when speaking of the machine, is your mobile
-device.
+device.
</dl>
-<p>Both the <b>Debug Client</b> and the <b>Debug Target</b> communicate to
+<p>Both the <b>Debug Client</b> and the <b>Debug Target</b> communicate to
the <b>Debug Server</b> via HTTP using <tt>XMLHttpRequest</tt> (XHR).
<p>Typically, you run both the <b>Debug Client</b> and the <b>Debug Server</b>
@@ -47,7 +47,7 @@
<p>When using the Mac application, the
<b>Debug Client</b> and <b>Debug Server</b> are running
in the same process.
-When you launch the application,
+When you launch the application,
the server starts, and then the browser included in the
application is launched
on the appropriate URL automagically.
@@ -75,7 +75,7 @@
<!-- ======================================================== -->
<h2>Running the debug server using the weinre.jar file</h2>
-<p>To run <span class="weinre">weinre</span> from the jar file,
+<p>To run <span class="weinre">weinre</span> from the jar file,
execute the following command:
<pre>
@@ -101,11 +101,11 @@
<div class="indent">
<p>The ip address to bind the server to.
<p>Default: <tt>localhost</tt>
-
+
<p>With the default of <tt>localhost</tt>, you won't be able to access
the server from any machine other than the one the server is running on. You will
need to bind to another hostname / ip address to make the server accessible to other
-machines. You can use the value <tt>-all-</tt> to indicate that you
+machines. You can use the value <tt>-all-</tt> to indicate that you
want to bind to all interfaces available on the current machine.
<p>Use <tt>ifconfig</tt> on Linux or the Mac, and <tt>ipconfig</tt>
@@ -120,7 +120,7 @@
<li><tt>--reuseAddr [true | false]</tt>
<div class="indent">
-<p>Sets the "reuseAddr" flag for Jetty.
+<p>Sets the "reuseAddr" flag for Jetty.
<p>Default: <tt>false</tt>
<p>May be needed if you restart your server frequently.
@@ -133,10 +133,10 @@
<p>Default: <tt>5</tt>
<p>Can probably be set larger, but then your browser may
-time out. Probably don't want to set it much lower than
+time out. Probably don't want to set it much lower than
this as it will cause additional network traffic when
no messages are being sent (it will cause more "empty"
-messages to be sent).
+messages to be sent).
</div>
<li><tt>--deathTimeout [seconds]</tt>
@@ -152,10 +152,10 @@
</ul>
-<p>You may also create a file named
-<tt>server.properties</tt> in the
+<p>You may also create a file named
+<tt>server.properties</tt> in the
directory <tt>.weinre</tt> in your
-home directory (eg.
+home directory (eg.
<tt>~/.weinre/server.properties</tt>).
The keys should be
the same as the name of the options above,
@@ -166,17 +166,22 @@
<pre>
boundHost: -all-
-httpPort: 8081
-reuseAddr: true
-readTimeout: 1
+httpPort: 8081
+reuseAddr: true
+readTimeout: 1
deathTimeout: 5
</pre>
<p>Command-line options override the options specified in the
-<tt>~/.weinre/server.properties</tt> file.
+<tt>~/.weinre/server.properties</tt> file.
<p>The server will run until you kill it. Control-C will do the job.
+<p>Below is what you should see from the console after running
+<span class="weinre">weinre</span> from the <tt>weinre.jar</tt> file.
+
+<p><img src="images/shell.png">
+
<!-- ======================================================== -->
<h2>Running the debug server using the Mac application</h2>
@@ -199,8 +204,8 @@
<!-- ======================================================== -->
<h2>Running the debug server bound to something other than <tt>localhost</tt></h3>
-<p>Since the web page you want to debug (the debug target) is probably running on
-a different machine (your mobile device) than the debug server (your desktop / laptop),
+<p>Since the web page you want to debug (the debug target) is probably running on
+a different machine (your mobile device) than the debug server (your desktop / laptop),
you <b>can't</b> use the
default <tt>localhost</tt> value for the <tt>--boundHost</tt>
option. Instead, you will need to specify a host name / ip address
@@ -217,12 +222,12 @@
using the URL <tt>http://localhost:[portNumber]/client/</tt>
from the same machine the debug server is running on. On that
page, under <b>Server Properties</b>, is a list of bound hosts
-that the server believes it's available on.
+that the server believes it's available on.
-<p>From the debug target device (eg, your mobile device),
+<p>From the debug target device (eg, your mobile device),
try accessing the server home page
from all of those host names, using the URL
-<tt>http://[host name / ipaddress]:[portNumber]/</tt>.
+<tt>http://[host name / ipaddress]:[portNumber]/</tt>.
Once you find one
that displays the server's home page correctly, remember
that host name / ip address, we'll be using it in a minute.
@@ -245,21 +250,21 @@
<p>To make your web page debuggable with <span class="weinre">weinre</span>,
add the following line to your web page:
<pre>
-<script src="http://a.b.c:8081/target/target-script-min.js"></script>
+<script src="http://a.b.c:8081/target/target-script-min.js"></script>
</pre>
<p>You can now open a debug client by browsing to
-<tt>http://a.b.c:8081/client</tt>
-(or probably
+<tt>http://a.b.c:8081/client</tt>
+(or probably
<tt>http://localhost:8081/client</tt>
-as well) on your desktop/laptop,
-then reload your newly instrumented web page on your mobile device,
+as well) on your desktop/laptop,
+then reload your newly instrumented web page on your mobile device,
and see the two connect in the Remote panel of the debug client.
<!-- ======================================================== -->
<h2>Hardcoding host names / IP addresses in your web page?</h3>
-<p>Yeah, gross.
+<p>Yeah, gross.
<p>Besides being gross, there are a few practical problems with hardcoding the
debug server address in your web page as well:
@@ -269,7 +274,7 @@
<li>Your html file is probably stored in an SCM, and you
don't really want to be storing that address in the SCM.
It won't work for other people using that html file,
-for instance.
+for instance.
<p>But you don't want to be keeping the
<tt><script src=""></tt> line in your SCM either.
@@ -277,13 +282,13 @@
build process to add that line only for development
builds, and presumably with a user-customizable URL.
-<li>The URL the debug server runs on may be
-different depending on your location. At work, you may use
+<li>The URL the debug server runs on may be
+different depending on your location. At work, you may use
one IP address and host name; at home, you likely have a different
IP address and host name. You may not have a host name at all,
just an IP address (which is fine - a host name isn't required,
but usually makes things easier). You may be running on a
-dynamically assigned IP address, in which case your IP
+dynamically assigned IP address, in which case your IP
changes every time you log into your network.
<p>One way out of the dilemma is to use a dynamic
@@ -296,13 +301,13 @@
can arrange to use the same host name for your debug server
no matter what network you are connected to.
-</ul>
+</ul>
<!-- ======================================================== -->
<h2>Using a bookmarklet</h2>
<p>Some platforms support 'bookmarkets', which allow you to inject
-arbitrary JavaScript code into any web page running in your
+arbitrary JavaScript code into any web page running in your
browser. Mobile Safari is one of these browsers. It appears that
the browser shipped with Android 2.2 and later also supports bookmarklets.
@@ -317,45 +322,3 @@
<p>Once the bookmarklet is installed, you can debug any web page
by visiting it, and selecting the bookmarklet from your bookmarks
menu.
-
-<!-- ======================================================== -->
-<h2>Using the <tt>target/target-script-min.js</tt> file statically</h2>
-
-<p>If you'd like to use the debug target code statically, instead of
-downloading it from the server all the time, then you will need to do
-one more thing. The debug target code computes the address of the
-debug server from the <tt>src</tt> attribute in the
-<tt><script></tt> tag, and it won't
-be correct in the static case. Instead you can set the
-following variable to be the URL of the debug server:
-
-<pre>
-window.WeinreServerURL
-</pre>
-
-<p>This URL overrides what's otherwise calculated from the debug target
-code itself. You will need to set this value before the
-<tt>target/target-script-min.js</tt> script is loaded.
-
-<!-- ======================================================== -->
-<h3>Future Enhancements</h3>
-
-<p>The calculation of the debug server url by the debug target is a bit fragile and
-ham-fisted. We should look at additional ways to handle this.
-For instance, we could prompt the user for the debug server
-address, and then always using the debug target in a more static
-mode; eg, you'd include the <tt>target-script-min.js</tt> with all your
-other files in your application.
-
-<p>Running the debug server on the target device is another option.
-This shouldn't be a huge problem for Android, but is more of a problem
-on iOS. By running the debug server on the target device, the
-debug target can always connect to the debug server by using a
-<tt>localhost</tt> hostname. The debug client, running on your
-desktop/laptop, would then need to connect to the target device
-to debug. In practice this may be an easier scenario to work with,
-as the potentially changing IP address of the mobile device just
-means having to type a different URL in your web browser on your desktop / laptop
-when running the debug client. That's easier than hard-coding
-URLs in your web page, for instance.
-
diff --git a/weinre.doc/Security.body.html b/weinre.doc/Security.body.html
index ab1d4ad..14e1ee3 100644
--- a/weinre.doc/Security.body.html
+++ b/weinre.doc/Security.body.html
@@ -1,7 +1,7 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
@@ -16,10 +16,10 @@
no level of authentication for requests.
<p>The primary security exposure with <span class="weinre">weinre</span> is via
-the debug server.
+the debug server.
<p>Currently, the server only reads files from the <tt>weinre.jar</tt> file,
-and from the <tt>~/.weinre/</tt> directory (for property files).
+and from the <tt>~/.weinre/</tt> directory (for property files).
The only thing the server writes to is <tt>stdout</tt> and <tt>stderr</tt>.
<p>If you use the default <tt>--boundHost</tt> option value of
@@ -27,16 +27,16 @@
server can communicate with the debug server. This probably isn't a big
deal, since presumably you control the software running on that machine.
-<p>If you use a non-default <tt>--boundHost</tt> option value,
+<p>If you use a non-default <tt>--boundHost</tt> option value,
then <b>any software on any machine that can access that specified
host can communicate with the debug server</b>. This is a much bigger
deal.
<p>The most obvious exposure with using <tt>--boundHost</tt> and
-a specific hostname / ip address, is that any debug client or
+a specific hostname / ip address, is that any debug client or
debug target that can access that hostname / ip address can access
-the server. For example, a rogue debug client could connect to
-your debug target and fiddle about with it.
+the server. For example, a rogue debug client could connect to
+your debug target and fiddle about with it.
<p>Other exposures include leaving a debug target injection
script line (ie, <tt><script src="[...]/target/target-script.js"></tt>)
@@ -48,39 +48,6 @@
<ul class="spaced">
-
-<li><b>use HTTPS with basic auth</b>
-
-<p>This shouldn't be a big problem with the debug client, but may be a pain in the ass
-since basic auth can be a pain in the ass (trying to log out of it).
-
-<p>On the debug target side, this is tougher, since the only HTTP access is done via
-XHR. So, presumably, we will need to tack on the userid/password to XHR requests,
-unless the browsers do that for us. That is, I assume the browsers don't throw up
-a password prompt when an XHR returns with an auth-required response code.
-
-<p>Storing userid/passwords on the client isn't going to be much fun. How do we even
-get these from the user?
-
-<p>Note that there is also a 'server discovery' issue we may want to do something
-about. That is, how does the debug target even know the URL of the server?
-If we want to allow the user to "enter it from the target", then entering the
-userid/password can fit into the same scheme, I guess.
-
-<p>Will need some light-weight userid/password store for the server, if
-we do this.
-
-<p>Will need to get the horrifying SSL keystore dance crap with Java
-in some kind of usable state. Should we ship a working, basic self-signed keystore
-that we recommend user's replace?
-
-<li><b>use HTTPS with OAuth</b>
-
-<p>Been a while, not sure if OAuth even helps with this,
-or how hard it would be to integrate support for it.
-
-<p>Same issue with HTTPS and the SSL keystore above.
-
-<li><b>other ideas?</b>
+<li>Let's chat
</ul>
diff --git a/weinre.doc/UserInterface.body.html b/weinre.doc/UserInterface.body.html
new file mode 100644
index 0000000..b5a95cd
--- /dev/null
+++ b/weinre.doc/UserInterface.body.html
@@ -0,0 +1,234 @@
+<!--
+ * weinre is available under *either* the terms of the modified BSD license *or* the
+ * MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
+ *
+ * Copyright (c) 2010, 2011 IBM Corporation
+-->
+
+<p>This page describes the user interface provided by <span class="weinre">weinre</span>.
+
+<!-- ======================================================================= -->
+<h2>the server home page</h2>
+
+<p><img src="images/server-home.png">
+
+<p>The server home page is accessed at the root URL of the server, in this case
+<tt>http://localhost:8081/</tt>.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>This link will launch the
+<span class="weinre">weinre</span> client page, which is the debugger itself.
+Clicking this link will take you to the Remote panel, described below.
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>This is the URL of the script that you add to your
+web page to allow it to be debugged by the client.
+</table>
+
+<p>Additional links shown in this image are for this documentation, and some demo
+pages.
+
+<p>Further down on the page, not shown in the image, are:
+
+<ul>
+<li>The text of the <tt><script src=></tt> element you can copy and paste into your
+web page.
+<li>The source for a bookmarklet, to inject the debug code into any web
+page displayed in your browser.
+<li>Version numbers of <span class="weinre">weinre</span> and it's components.
+</ul>
+
+<!-- ======================================================================= -->
+<h2>the Remote panel</h2>
+
+<p><img src="images/panel-remote.png">
+
+<p>The Remote panel is the initial panel of <span class="weinre">weinre</span>,
+and displays some status regarding the server.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The top portion of all of the
+<span class="weinre">weinre</span> panels shows the panel switcher. To switch
+to a different panel, click on the panel's button. The current panel is displayed with
+a highlight, as shown above for the Remote panel.
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>The Targets section of this page lists targets that are currently connected
+to the server. A target is a web page that you are debugging.
+In this case, there is one target connected the server. Information
+about each target is displayed in the list, including host name / ip address, and
+the URL the target is displaying.
+</table>
+
+<p><table><tr><td><img src="images/circled-c.png">
+<td>The Clients section of this page lists the clients that are currently connected
+to the server. A client is this user interface. Typically, there is just one - the client you are displaying
+at the time.
+</table>
+
+<p><table><tr><td><img src="images/circled-d.png">
+<td>The Server Properties section of this page displays the values of various server
+properties currently in effect. Shown here are the hosts that are bound to the
+server - which host names / ip addresses that the server will respond to.
+</table>
+
+<p>The colors of the entries in the Targets and Clients list indicates their
+status. Blue means the Target or Client is connected to the server, but not
+yet connected to a peer. Green means the Target or Client is connected to a
+peer, and you can start debugging. Red means the Target or Client has
+disconnected from the server, and will eventually fade away and be removed
+from the list.
+
+<p>In case there are multiple targets connected, you can switch which one you
+are debugging by clicking on the item.
+
+<!-- ======================================================================= -->
+<h2>the Elements panel</h2>
+
+<p><img src="images/panel-elements.png">
+
+<p>The Elements panel displays your HTML DOM in a tree fashion, and properties
+associated with selected elements.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The elements themselves may be expanded/collapsed via the disclosure buttons.
+Elements and text can be edited by double-clicking the item to be edited.
+Elements can also be deleted by selecting the element and then pressing the
+delete button.
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>The sidebar area displays information about the selected element. In this case,
+the Styles sidebar is expanded, showing relevant CSS rules. Some sidebars allow
+editing of the contents. The Styles sidebar in particular allows you to add, edit
+and remove properties and values by double clicking on them.
+</table>
+
+<!-- ======================================================================= -->
+<h2>the Resources panel</h2>
+
+<p><img src="images/panel-resources.png">
+
+<p>The Resources panel shows WebSQL databases, and data stored in Local Storage
+and Session Storage.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The left hand side of the Resources panel is the navigator. Expanding
+the Databases entry will show all the Web SQL databases currently in use.
+Expanding a particular database will show all the tables in that database.
+
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>The right hand side is the editor/viewer for whatever is selected in the
+navigator pane.
+When a database is selected, a prompt will appear in the editor/viewer area
+where you can enter SQL statements to be executed. The results are displayed
+inline. When a table is selected, all the rows from the table will be displayed.
+When a Local Storage or Session Storage entry is selected, all the relevant keys
+and values will be displayed. The keys and values in the Local Storage and
+Session Storage tables can be edited by double-clicking.
+</table>
+
+<p><table><tr><td><img src="images/circled-c.png">
+<td>The reload button will refresh the data from the target.
+</table>
+
+<!-- ======================================================================= -->
+<h2>the Network panel</h2>
+
+<p><img src="images/panel-network.png">
+
+<p>The Network panel shows you information regarding XHR requests that you've
+made.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>Each XHR will be shown in a separate row in the table. Clicking the
+path name of the XHR request will show additional information for that
+request in the right side of the panel.
+To display the table again, click the (x)
+button in the left top corner of the information pane (not shown in the
+image above).
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>The "dots and lines" button can be used to change the table layout to
+show less information in a more compact format.
+</table>
+
+<p><table><tr><td><img src="images/circled-c.png">
+<td>The "not" button will clear the entries from the table.
+</table>
+
+<!-- ======================================================================= -->
+<h2>the Timeline panel</h2>
+
+<p><img src="images/panel-timeline.png">
+
+<p>The Timeline panel is used to show events that are occurring in the target.
+Currently only two types of events are shown: timers/intervals, and user-specified
+events. Use <tt>console.markTimeline("A Label")</tt> to add a user-specified
+event to the timeline with the specified label.
+
+<p>Note that timing events are not collected unless you enable the "record"
+button (see below).
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The left hand pane of the Timeline panel shows the events that have occurred.
+Hovering over an entry will show additional detail about the event.
+</table>
+
+<p><table><tr><td><img src="images/circled-b.png">
+<td>The right hand pane of the Timeline panel shows the events as they occurred
+in time. Some events have other events associated with them, which will be shown
+when the disclosure triangle is expanded. The top-most time line of the right
+panel can have it's right and left hand edges moved to show a particular time
+range in more detail.
+</table>
+
+<p><table><tr><td><img src="images/circled-c.png">
+<td>The "dots and lines" button can be used to show and hide events that last
+less than a fixed time (currently 15ms).
+</table>
+
+<p><table><tr><td><img src="images/circled-d.png">
+<td>The "record" button is used to start or stop event collection. When
+<span class="weinre">weinre</span> starts, the record button is off (black).
+When you click the record button to start collecting events, it will turn
+red.
+</table>
+
+<p><table><tr><td><img src="images/circled-e.png">
+<td>The "not" button will clear the current timing entries.
+</table>
+
+
+<!-- ======================================================================= -->
+<h2>the Console panel</h2>
+
+<p><img src="images/panel-console.png">
+
+<p>The Console panel is used to execute arbitrary JavaScript expressions/statements. It
+also shows the output from various <tt>console</tt> methods, like
+<tt>console.log()</tt>.
+
+<p>In the example above, the JavaScript statements entered by the user are in
+blue, the output of the statements is just below it, and messages generated by
+<tt>console.log()</tt> are in black.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The "not" button will clear the console.
+</table>
+
+<p><img src="images/panel-remote-console.png">
+
+<p>The Console can also be embedded in every panel, by clicking the "console"
+button.
+
+<table><tr><td><img src="images/circled-a.png">
+<td>The "console" button will embed the console in the bottom half of the
+other panels, or hide it if it's currently embedded in the other panels.
+</table>
+
diff --git a/weinre.doc/boilerplate-header.html.txt b/weinre.doc/boilerplate-header.html.txt
index f237a28..73acd31 100644
--- a/weinre.doc/boilerplate-header.html.txt
+++ b/weinre.doc/boilerplate-header.html.txt
@@ -3,7 +3,7 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
@@ -12,32 +12,18 @@
<title>weinre - @PAGE_NAME@</title>
<link rel="stylesheet" href="css/main.css" type="text/css">
<link rel="shortcut icon" href="images/weinre-icon-64x64.png" />
-<script src="scripts/main.js"></script>
-<script type="text/javascript">
-
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-736164-7']);
- _gaq.push(['_trackPageview']);
-
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
-
-</script>
</head>
<body>
-<a class="no-decoration" href="https://github.com/phonegap/weinre"><div class="ribbon">Fork weinre on GitHub</div></a>
+<a class="no-decoration" href="https://github.com/callback/callback-weinre"><div class="ribbon">Fork weinre on GitHub</div></a>
<!-- ======================================================================= -->
<h1 class="page-title">weinre - @PAGE_NAME@</h1>
<div class="toc">
<a href="Home.html">Home</a>
-- <a href="TestDrive.html">Test Drive</a>
+- <a href="UserInterface.html">User Interface</a>
- <a href="Installing.html">Installing</a>
- <a href="Running.html">Running</a>
- <a href="MultiUser.html">Multi-User</a>
diff --git a/weinre.doc/boilerplate-trailer.html.txt b/weinre.doc/boilerplate-trailer.html.txt
index 7c782f5..f2244a0 100644
--- a/weinre.doc/boilerplate-trailer.html.txt
+++ b/weinre.doc/boilerplate-trailer.html.txt
@@ -3,7 +3,7 @@
<!--
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
-->
@@ -11,7 +11,7 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<p>
<a href="Home.html">Home</a>
-- <a href="TestDrive.html">Test Drive</a>
+- <a href="UserInterface.html">User Interface</a>
- <a href="Installing.html">Installing</a>
- <a href="Running.html">Running</a>
- <a href="MultiUser.html">Multi-User</a>
diff --git a/weinre.doc/css/main.css b/weinre.doc/css/main.css
index 850bd78..ba071e2 100644
--- a/weinre.doc/css/main.css
+++ b/weinre.doc/css/main.css
@@ -1,7 +1,7 @@
/*
* weinre is available under *either* the terms of the modified BSD license *or* the
* MIT License (2008). See http://opensource.org/licenses/alphabetical for full text.
- *
+ *
* Copyright (c) 2010, 2011 IBM Corporation
*/
@@ -17,8 +17,8 @@
left: 0;
border-right: thin solid #000;
border-bottom: thin solid #000;
- -moz-border-radius-bottomright: 0.5em;
- -webkit-border-bottom-right-radius: 0.5em;
+ -moz-border-radius-bottomright: 0.5em;
+ -webkit-border-bottom-right-radius: 0.5em;
padding: 0.25em 0.5em;
background-color: #FF0;
font-style: italic;
@@ -33,6 +33,11 @@
}
/*-----------------------------------------------------------------*/
+.strike {
+ text-decoration: line-through;
+}
+
+/*-----------------------------------------------------------------*/
.weinre {
color: #088;
font-style: italic;
@@ -123,9 +128,9 @@
padding: 0.00em 0.5em;
border-width: 1;
border-style: solid;
- border-radius: 0.5em;
- -moz-border-radius: 0.5em;
- -webkit-border-radius: 0.5em;
+ border-radius: 0.5em;
+ -moz-border-radius: 0.5em;
+ -webkit-border-radius: 0.5em;
}
/*-----------------------------------------------------------------*/
@@ -140,29 +145,29 @@
margin-left: 1.4em;
margin-right: 1.4em;
background: #FFFFDF;
- border-radius: 0.5em;
- -moz-border-radius: 0.5em;
- -webkit-border-radius: 0.5em;
- box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
- -moz-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
- -webkit-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ border-radius: 0.5em;
+ -moz-border-radius: 0.5em;
+ -webkit-border-radius: 0.5em;
+ box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ -moz-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ -webkit-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
}
/*-----------------------------------------------------------------*/
h2 {
padding: 0.25em 0.50em;
background-color: #DDD;
- border-radius: 0.5em;
- -moz-border-radius: 0.5em;
- -webkit-border-radius: 0.5em;
+ border-radius: 0.5em;
+ -moz-border-radius: 0.5em;
+ -webkit-border-radius: 0.5em;
}
/*-----------------------------------------------------------------*/
kewl {
- box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
- -moz-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
- -webkit-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
- border-radius: 0.5em;
- -moz-border-radius: 0.5em;
- -webkit-border-radius: 0.5em;
+ box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ -moz-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ -webkit-box-shadow: 0.3em 0.3em 0.3em 0em #DDD;
+ border-radius: 0.5em;
+ -moz-border-radius: 0.5em;
+ -webkit-border-radius: 0.5em;
}
diff --git a/weinre.doc/images/circled-a.png b/weinre.doc/images/circled-a.png
new file mode 100644
index 0000000..98c0558
--- /dev/null
+++ b/weinre.doc/images/circled-a.png
Binary files differ
diff --git a/weinre.doc/images/circled-b.png b/weinre.doc/images/circled-b.png
new file mode 100644
index 0000000..0d80f3c
--- /dev/null
+++ b/weinre.doc/images/circled-b.png
Binary files differ
diff --git a/weinre.doc/images/circled-c.png b/weinre.doc/images/circled-c.png
new file mode 100644
index 0000000..f876019
--- /dev/null
+++ b/weinre.doc/images/circled-c.png
Binary files differ
diff --git a/weinre.doc/images/circled-d.png b/weinre.doc/images/circled-d.png
new file mode 100644
index 0000000..8e58ca8
--- /dev/null
+++ b/weinre.doc/images/circled-d.png
Binary files differ
diff --git a/weinre.doc/images/circled-e.png b/weinre.doc/images/circled-e.png
new file mode 100644
index 0000000..f3a782a
--- /dev/null
+++ b/weinre.doc/images/circled-e.png
Binary files differ
diff --git a/weinre.doc/images/circled-f.png b/weinre.doc/images/circled-f.png
new file mode 100644
index 0000000..4998913
--- /dev/null
+++ b/weinre.doc/images/circled-f.png
Binary files differ
diff --git a/weinre.doc/images/circled-g.png b/weinre.doc/images/circled-g.png
new file mode 100644
index 0000000..888bcee
--- /dev/null
+++ b/weinre.doc/images/circled-g.png
Binary files differ
diff --git a/weinre.doc/images/circled-h.png b/weinre.doc/images/circled-h.png
new file mode 100644
index 0000000..174d731
--- /dev/null
+++ b/weinre.doc/images/circled-h.png
Binary files differ
diff --git a/weinre.doc/images/circled-i.png b/weinre.doc/images/circled-i.png
new file mode 100644
index 0000000..338c341
--- /dev/null
+++ b/weinre.doc/images/circled-i.png
Binary files differ
diff --git a/weinre.doc/images/circled-j.png b/weinre.doc/images/circled-j.png
new file mode 100644
index 0000000..6595d75
--- /dev/null
+++ b/weinre.doc/images/circled-j.png
Binary files differ
diff --git a/weinre.doc/images/gmail-green-target-client.jpg b/weinre.doc/images/gmail-green-target-client.jpg
deleted file mode 100644
index 778916a..0000000
--- a/weinre.doc/images/gmail-green-target-client.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/orig/panel-console.png b/weinre.doc/images/orig/panel-console.png
new file mode 100644
index 0000000..3a8d794
--- /dev/null
+++ b/weinre.doc/images/orig/panel-console.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-elements.png b/weinre.doc/images/orig/panel-elements.png
new file mode 100644
index 0000000..4b81020
--- /dev/null
+++ b/weinre.doc/images/orig/panel-elements.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-network.png b/weinre.doc/images/orig/panel-network.png
new file mode 100644
index 0000000..6cc5a59
--- /dev/null
+++ b/weinre.doc/images/orig/panel-network.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-remote-console.png b/weinre.doc/images/orig/panel-remote-console.png
new file mode 100644
index 0000000..14db266
--- /dev/null
+++ b/weinre.doc/images/orig/panel-remote-console.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-remote.png b/weinre.doc/images/orig/panel-remote.png
new file mode 100644
index 0000000..0a5374c
--- /dev/null
+++ b/weinre.doc/images/orig/panel-remote.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-resources.png b/weinre.doc/images/orig/panel-resources.png
new file mode 100644
index 0000000..2b1a2fc
--- /dev/null
+++ b/weinre.doc/images/orig/panel-resources.png
Binary files differ
diff --git a/weinre.doc/images/orig/panel-timeline.png b/weinre.doc/images/orig/panel-timeline.png
new file mode 100644
index 0000000..a5d7ff5
--- /dev/null
+++ b/weinre.doc/images/orig/panel-timeline.png
Binary files differ
diff --git a/weinre.doc/images/orig/server-home.png b/weinre.doc/images/orig/server-home.png
new file mode 100644
index 0000000..4a2628f
--- /dev/null
+++ b/weinre.doc/images/orig/server-home.png
Binary files differ
diff --git a/weinre.doc/images/orig/shell.png b/weinre.doc/images/orig/shell.png
new file mode 100644
index 0000000..d43f51c
--- /dev/null
+++ b/weinre.doc/images/orig/shell.png
Binary files differ
diff --git a/weinre.doc/images/panel-console.png b/weinre.doc/images/panel-console.png
new file mode 100644
index 0000000..5f43882
--- /dev/null
+++ b/weinre.doc/images/panel-console.png
Binary files differ
diff --git a/weinre.doc/images/panel-elements.png b/weinre.doc/images/panel-elements.png
new file mode 100644
index 0000000..c05defa
--- /dev/null
+++ b/weinre.doc/images/panel-elements.png
Binary files differ
diff --git a/weinre.doc/images/panel-network.png b/weinre.doc/images/panel-network.png
new file mode 100644
index 0000000..b2ddcae
--- /dev/null
+++ b/weinre.doc/images/panel-network.png
Binary files differ
diff --git a/weinre.doc/images/panel-remote-console.png b/weinre.doc/images/panel-remote-console.png
new file mode 100644
index 0000000..dcb9e9b
--- /dev/null
+++ b/weinre.doc/images/panel-remote-console.png
Binary files differ
diff --git a/weinre.doc/images/panel-remote.png b/weinre.doc/images/panel-remote.png
new file mode 100644
index 0000000..08f4749
--- /dev/null
+++ b/weinre.doc/images/panel-remote.png
Binary files differ
diff --git a/weinre.doc/images/panel-resources.png b/weinre.doc/images/panel-resources.png
new file mode 100644
index 0000000..e6f5bd2
--- /dev/null
+++ b/weinre.doc/images/panel-resources.png
Binary files differ
diff --git a/weinre.doc/images/panel-timeline.png b/weinre.doc/images/panel-timeline.png
new file mode 100644
index 0000000..f4136ab
--- /dev/null
+++ b/weinre.doc/images/panel-timeline.png
Binary files differ
diff --git a/weinre.doc/images/server-home.png b/weinre.doc/images/server-home.png
new file mode 100644
index 0000000..a52815f
--- /dev/null
+++ b/weinre.doc/images/server-home.png
Binary files differ
diff --git a/weinre.doc/images/shell.png b/weinre.doc/images/shell.png
new file mode 100644
index 0000000..d43f51c
--- /dev/null
+++ b/weinre.doc/images/shell.png
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-01-h.jpg b/weinre.doc/images/weinre-cli-01-h.jpg
deleted file mode 100644
index f4edc9a..0000000
--- a/weinre.doc/images/weinre-cli-01-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-01-p.jpg b/weinre.doc/images/weinre-cli-01-p.jpg
deleted file mode 100644
index f4edc9a..0000000
--- a/weinre.doc/images/weinre-cli-01-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-02-h.jpg b/weinre.doc/images/weinre-cli-02-h.jpg
deleted file mode 100644
index b083a76..0000000
--- a/weinre.doc/images/weinre-cli-02-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-02-p.jpg b/weinre.doc/images/weinre-cli-02-p.jpg
deleted file mode 100644
index edcefde..0000000
--- a/weinre.doc/images/weinre-cli-02-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-03-h.jpg b/weinre.doc/images/weinre-cli-03-h.jpg
deleted file mode 100644
index e8e4400..0000000
--- a/weinre.doc/images/weinre-cli-03-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-03-p.jpg b/weinre.doc/images/weinre-cli-03-p.jpg
deleted file mode 100644
index 52f2e73..0000000
--- a/weinre.doc/images/weinre-cli-03-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-04-h.jpg b/weinre.doc/images/weinre-cli-04-h.jpg
deleted file mode 100644
index da42f56..0000000
--- a/weinre.doc/images/weinre-cli-04-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-04-p.jpg b/weinre.doc/images/weinre-cli-04-p.jpg
deleted file mode 100644
index 49bd84d..0000000
--- a/weinre.doc/images/weinre-cli-04-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-05-h.jpg b/weinre.doc/images/weinre-cli-05-h.jpg
deleted file mode 100644
index 84f48a6..0000000
--- a/weinre.doc/images/weinre-cli-05-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-05-p.jpg b/weinre.doc/images/weinre-cli-05-p.jpg
deleted file mode 100644
index 84f48a6..0000000
--- a/weinre.doc/images/weinre-cli-05-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-06-h.jpg b/weinre.doc/images/weinre-cli-06-h.jpg
deleted file mode 100644
index 676fee1..0000000
--- a/weinre.doc/images/weinre-cli-06-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-06-p.jpg b/weinre.doc/images/weinre-cli-06-p.jpg
deleted file mode 100644
index d4d2b56..0000000
--- a/weinre.doc/images/weinre-cli-06-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-07-h.jpg b/weinre.doc/images/weinre-cli-07-h.jpg
deleted file mode 100644
index 2614375..0000000
--- a/weinre.doc/images/weinre-cli-07-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-cli-07-p.jpg b/weinre.doc/images/weinre-cli-07-p.jpg
deleted file mode 100644
index 2614375..0000000
--- a/weinre.doc/images/weinre-cli-07-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-con-01-h.jpg b/weinre.doc/images/weinre-con-01-h.jpg
deleted file mode 100644
index 2051127..0000000
--- a/weinre.doc/images/weinre-con-01-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-con-01-p.jpg b/weinre.doc/images/weinre-con-01-p.jpg
deleted file mode 100644
index 35ec12e..0000000
--- a/weinre.doc/images/weinre-con-01-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-con-02-h.jpg b/weinre.doc/images/weinre-con-02-h.jpg
deleted file mode 100644
index a7620e3..0000000
--- a/weinre.doc/images/weinre-con-02-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-con-02-p.jpg b/weinre.doc/images/weinre-con-02-p.jpg
deleted file mode 100644
index a7620e3..0000000
--- a/weinre.doc/images/weinre-con-02-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-demo.jpg b/weinre.doc/images/weinre-demo.jpg
new file mode 100644
index 0000000..efd5829
--- /dev/null
+++ b/weinre.doc/images/weinre-demo.jpg
Binary files differ
diff --git a/weinre.doc/images/weinre-frn-01-h.jpg b/weinre.doc/images/weinre-frn-01-h.jpg
deleted file mode 100644
index 82ad660..0000000
--- a/weinre.doc/images/weinre-frn-01-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-frn-01-p.jpg b/weinre.doc/images/weinre-frn-01-p.jpg
deleted file mode 100644
index f631e06..0000000
--- a/weinre.doc/images/weinre-frn-01-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-tar-01-h.jpg b/weinre.doc/images/weinre-tar-01-h.jpg
deleted file mode 100644
index 7663c0d..0000000
--- a/weinre.doc/images/weinre-tar-01-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-tar-01-p.jpg b/weinre.doc/images/weinre-tar-01-p.jpg
deleted file mode 100644
index 7663c0d..0000000
--- a/weinre.doc/images/weinre-tar-01-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-tar-02-h.jpg b/weinre.doc/images/weinre-tar-02-h.jpg
deleted file mode 100644
index c93cd71..0000000
--- a/weinre.doc/images/weinre-tar-02-h.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.doc/images/weinre-tar-02-p.jpg b/weinre.doc/images/weinre-tar-02-p.jpg
deleted file mode 100644
index c93cd71..0000000
--- a/weinre.doc/images/weinre-tar-02-p.jpg
+++ /dev/null
Binary files differ
diff --git a/weinre.web/index.html b/weinre.web/index.html
index 778358a..a4861d5 100644
--- a/weinre.web/index.html
+++ b/weinre.web/index.html
@@ -14,7 +14,7 @@
<link rel="shortcut icon" href="images/weinre-icon-64x64.png" />
<script src="versions.js"></script>
<style>
-.hilite {
+.underline {
border-bottom: solid;
}
h1, h2 {
@@ -39,8 +39,8 @@
</style>
</head>
<body>
-<h1>weinre</h1>
-<p><span class="hilite">we</span>b <span class="hilite">in</span>spector <span class="hilite">re</span>mote
+<h1>weinre - <span class="underline">we</span>b <span class="underline">in</span>spector <span class="underline">re</span>mote</h1>
+
<h2>Access Points</h2>
