====== Zeroi ======

The main idea of Zeroi is to be able to use any logging system (like SOS, XRay, Luminic Box, XTrace...) in your MTASC project, without having to change the code of your app. In fact your code doesn't even need to know about Zeroi. Inside your app you only use trace statements. The traces are forwarded to the logging system of your choice.

That's what the name Zeroi is standing for: Zero Impact.

Zeroi supports loglevels and an optional LoggerConfig XML file to set special loglevels for classes and packages.

===== Specification =====

  * **Category:** IDE/ActionScript Library/etc. 
  * **Audience:** Developers
  * **Platform:** Cross-platform
  * **Maturity:** Beta
  * **License:** LGPL


===== Download =====

You can download the latest release version [[http://code.google.com/p/zeroi/downloads/list |here]].

===== Installation instructions =====

There is no installation. You only have to add the zeroi classpath and the a few classes to your MTASC compile arguments.


===== Usage instructions =====

The usage of Zeroi is very simple which is implicised by the name Zeroi which means "zero impact".

If you are alreay familiar with MTASC simply check out the subversion repository read the README.txt and study the example including the corresponding ANT build.xml.
More detailed instructions follow if there is an audiance for it.

In short words add this to your MTASC commandline:
  * -cp [PATH_TO_ZEROI_FILES]
  * -trace org.osflash.zeroi.logging.LoggerClass.log
  * org/osflash/zeroi/logging/LoggerClass
  * org/osflash/zeroi/logging/publisher/SOSPublisher (to use [[http://sos.powerflasher.com|SOS]])
  * org/osflash/zeroi/logging/publisher/XRayPublisher (to use [[http://osflash.org/xray|XRay]])
  * org/osflash/zeroi/logging/publisher/LuminicPublisher (to use [[http://www.luminicbox.com|LuminicBox]])
  * org/osflash/zeroi/logging/publisher/XTracePublisher (to use [[http://www.osflash.org/xtrace|XTrace]])
  * org/osflash/zeroi/logging/publisher/TextFieldPublisher (to use a simple dragable TextField)

If you want to use a logconfig XML-File do it like in the example [[http://svn1.cvsdude.com/osflash/zeroi/deploy/build/as/org/osflash/zeroi/example/ZeroiExampleMainClass.as|MainClass]] using LoggerConfig.init([PATH_TO_CONFIG.xml], callback);

To understand it also see the example [[http://svn1.cvsdude.com/osflash/zeroi/deploy/logConfig.xml|logConfig.xml]].

To get an idea of how the log output looks like:
{{zeroi_sos.gif}}

Of every log you see:
  * classname
  * methodname
  * linenumber
  * log output


===== Tutorials =====

Using Zeroi with LuminicBox.Log (FlashInspector):
[[http://www.websector.de/blog/2007/03/04/debugging-with-mtasc-ant-and-zeroi/ |http://www.websector.de/blog/2007/03/04/debugging-with-mtasc-ant-and-zeroi/]]

Using Zeroi with XTrace: [[http://www.websector.de/blog/2007/03/12/extension-for-zeroi-xtracepublisher/|http://www.websector.de/blog/2007/03/12/extension-for-zeroi-xtracepublisher/]]

===== Mailing list =====

There is a community of users and developers for this project who share their experiences on the mailing list. Please search through the archives to see if your question has been answered before submitting it to the mailing list.

[[http://osflash.org/mailman/listinfo/zeroi_osflash.org|Zeroi Mailing List]]: Subscribe and manage your subscription

[[http://osflash.org/pipermail/zeroi_osflash.org/|Archives]]


===== Subversion repository =====

This project has a Subversion (SVN) repository at:
[[http://code.google.com/p/zeroi/source|Zeroi Subversion Repository]]

===== Known Bugs =====

Sometimes the history replays twice and you got the first logs doubled when using SOS.

===== Future Feature =====

Also define special methods of a class with a LogLevel so LogLevel definition goes down to methods.


===== Wishlist =====

Any feature you are missing? Please tell us and also write it into the mailinglist!

  * Optional show package instead of only the classname
  * Changelog and version number
  * Tutorials/HowTo's/SampleFiles for using different logging systems
  * <del>Support for XTrace</del>




===== Credits =====

  - Ralf Bokelberg (Main programming)
  - Sönke Rohde (LoggerConfig/Filter via XML)
  - sectore (extension for XTrace, tutorials)

===== License =====

[[http://www.gnu.org/licenses/lgpl.html|LGPL]]