Skip to content

Latest commit

 

History

History
100 lines (52 loc) · 2.77 KB

README.markdown

File metadata and controls

100 lines (52 loc) · 2.77 KB
Raw

WaterBug

WaterBug is an attempt to build a javascript-based debugging tool for all browsers.

Inspiration

WaterBug was inspired by FireBug, the best ever debug tool. FireBug's developed as an addon to Firefox which makes it unaccessible for other browsers. WaterBug's idea is to make a tool that is browser-independent.

History

First attempt can be found here.

Its three problems were:

  • dependency on Prototype javascript framework
  • low efficiency
  • unclear code

The new tool shoud fix all the problems.

Current state

Currently WaterBug is in an early development state. New modules will be added periodically as the previous ones become stable and satisfactionary.

I'd appreciate if anyone wanted to contribute by building new modules.

For details please reffer to the latest stable version.

Latest stable version

Current version is stable_1.00.

This version provides a fully functional javascript console and error handling.

Thested with:

  • IE6
  • IE7
  • IE8
  • OSX Chrome
  • OSX Firefox

In IE6 the main container styles will be broken because it doesn't support position:fixed. The functionality is usable however.

Development

Simply run ruby generate.rb. The script generates files into the generated/ directory.

Please see the coding guidelines here.

Usage

The examples below explain how to use version stable_1.00.

To use other versions just replace stable_1.00 with the branch or tag you want to use.

To use WaterBug you have to either:

  • include it in your website's header:

    <script type="text/javascript" src="http://github.com/szarski/WaterBug/raw/stable_1.00/generated/waterbug.js"></script>

  • dynamically ad it by issuing this code:

    node = document.createElement('script');
node.type = 'text/javascript';
node.src = document.location.protocol+'//github.com/szarski/WaterBug/raw/stable_1.00/generated/waterbug.js';
document.getElementsByTagName("head")[0].appendChild(node);

  • just insert this into the url once the page is loaded:

    javascript:node = document.createElement('script');node.type = 'text/javascript';node.src = document.location.protocol+'//github.com/szarski/WaterBug/raw/stable_1.00/generated/waterbug.js';document.getElementsByTagName("head")[0].appendChild(node);alert('WaterBug loaded!');

Please note that only the first option will allow you to catch exceptions that appear when the page is being loaded.

License

Copyright (c) 2010 Jacek Szarski

jacek@applicake.com

Released under the GPL license.

ToDo

  • improve IE6 css related to positioning elements