Gitiles
Code Review Sign In
gerrit.opencord.org / xos / 9da40fb5f4b7083b662ff505579f1cc5ea6ad17b / . / planetstack / core / static / log4javascript-1.4.6 / docs / index.html
blob: d3b3ac22f844ebefe451ac06392c67ce21ac05d4 [file] [log] [blame]
Siobhan Tullye18b3442014-02-23 14:23:34 -0500[diff] [blame]1<?xml version="1.0"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4 <head>
5 <title>log4javascript documentation</title>
6 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
7 <meta name="author" content="Tim Down - tim@log4javascript.org" />
8 <meta name="description" content="log4javascript, a logging framework for JavaScript based on log4j" />
9 <meta name="robots" content="all" />
10 <link rel="stylesheet" type="text/css" media="screen,print" href="../main.css" title="Default" />
11 </head>
12 <body>
13 <div id="container" class="nonav">
14 <div id="header">
15 <h1><a href="../index.html">log4javascript</a></h1>
16 <div id="nav">
17 <a class="navitem" href="../index.html">home</a>
18 | <a class="navitem" href="http://sourceforge.net/projects/log4javascript" target="_blank" title="Download (opens in new window)">download</a>
19 | <span class="navitem">docs</span>
20 | <a class="navitem" href="quickstart.html">quick start</a>
21 | <a class="navitem" href="../demos/index.html">demos</a>
22 | <a class="navitem" href="http://log4javascript.org" target="_blank">website</a>
23 | <a class="navitem" href="http://www.timdown.co.uk" target="_blank">timdown.co.uk</a>
24 </div>
25 </div>
26 <div id="content">
27 <h1>log4javascript 1.4 documentation</h1>
28 <div id="links">
29 <h2>Links</h2>
30 <ul>
31 <li><a href="quickstart.html">Quick start</a></li>
32 <li><a href="distribution.html">Details of the log4javascript distribution</a></li>
33 <li><a href="backwardsincompatibilities.html">Backwards incompatibilities</a></li>
34 <li><a href="whatsnew.html">What's new in this release</a></li>
35 <li><a href="../changelog.txt">Change log</a></li>
36 <li><a href="manual.html">log4javascript manual</a></li>
37 <li><a href="lite.html">log4javascript Lite</a></li>
38 <li><a href="manual_lite.html">log4javascript Lite manual</a></li>
39 <li><a href="../demos/basic.html">Basic demo</a></li>
40 <li><a href="../demos/ajax.html">Ajax demo</a></li>
41 </ul>
42 </div>
43 <div id="contents">
44 <h2>Contents</h2>
45 <ul>
46 <li><a href="#whatitis">What it is</a></li>
47 <li><a href="#whofor">Who it's for</a></li>
48 <li><a href="#previousversions">Note on previous versions</a></li>
49 <li><a href="#features">Features</a></li>
50 <li><a href="#browsers">Browser support</a></li>
51 <li><a href="#licence">Licence</a></li>
52 <li><a href="#furtherreading">Further reading</a></li>
53 </ul>
54 </div>
55 <div id="whatitis">
56 <h2>What it is</h2>
57 <p>
58 log4javascript is a JavaScript logging framework based on the Java
59 logging framework <a href="http://logging.apache.org/log4j/docs/index.html"
60 title="log4j home page (opens in new window)" target="_blank">log4j</a>.
61 </p>
62 <p>
63 log4javascript implements a subset of log4j (primarily loggers, appenders
64 and layouts) and has a few convenience methods of its own for
65 quick JavaScript development. It can be used to debug JavaScript
66 applications of all sizes, including Ajax applications.
67 </p>
68 <p>
69 If you just want to start using it, try the <a href="quickstart.html">quickstart
70 tutorial</a>.
71 </p>
72 <p class="linktotop">
73 <a href="#container">Top</a>
74 </p>
75 </div>
76 <div id="whofor">
77 <h2>Who it's for</h2>
78 <p>
79 log4javascript is aimed at JavaScript developers.
80 </p>
81 <p class="linktotop">
82 <a href="#container">Top</a>
83 </p>
84 </div>
85 <div id="previousversions">
86 <h2>Note on previous versions</h2>
87 <p>
88 Documentation for previous versions of log4javascript are not available here.
89 However, documentation is bundled with every previous version, all of which
90 are <a href="http://sourceforge.net/projects/log4javascript"
91 target="_blank" title="Download (opens in new window)">available to download</a>.
92 </p>
93 </div>
94 <div id="features">
95 <h2>Features</h2>
96 <ul>
97 <li>can be initialized with one JavaScript include and one line of code;</li>
98 <li>
99 by default logs to a pop-up console window with powerful search (including
100 regular expression) and filtering features. This console window can also
101 be used inline as an iframe in the main page;
102 </li>
103 <li>
104 can send log messages to the server via HTTP (Ajax, if you like);
105 </li>
106 <li>
107 highly configurable using familiar methods from log4j, including the
108 powerful <code><a href="manual.html#patternlayout">PatternLayout</a></code>
109 which gives the developer complete control over the format of the log messages.
110 </li>
111 </ul>
112 <p class="linktotop">
113 <a href="#container">Top</a>
114 </p>
115 </div>
116 <div id="browsers">
117 <h2>Browser support</h2>
118 <h3>Fully supported browsers:</h3>
119 <ul>
120 <li>All versions Firefox back to 0.6</li>
121 <li>Other Mozilla-based browsers, as far back as Netscape 7</li>
122 <li>Internet Explorer 5 and higher for Windows</li>
123 <li>Safari 1.3 and higher (untested on earlier versions)</li>
124 <li>Opera 8.01 and higher (pre- version 9 browsers have a rendering
125 bug related to scrolling that affects searching in PopUpAppender and InPageAppender)</li>
126 <li>Konqueror 3.4.3 and higher (untested on earlier versions)</li>
127 <li>Google Chrome</li>
128 </ul>
129 <h3>Partially supported browsers:</h3>
130 <ul>
131 <li>Older Mozilla-based browsers, e.g. Netscape 6.2 (generally OK except for
132 display problems searching and filtering PopUpAppender and InPageAppender)</li>
133 <li>Opera 7.0 - 8.0 (InPageAppender not supported until version 7.5, plus some display
134 problems searching PopUpAppender and InPageAppender. AjaxAppender not supported at all)</li>
135 </ul>
136 <h3>Unsupported browsers:</h3>
137 <ul>
138 <li>
139 Internet Explorer for Mac. There are no plans to make log4javascript work
140 in this browser.
141 </li>
142 </ul>
143 <p class="linktotop">
144 <a href="#container">Top</a>
145 </p>
146 </div>
147 <div id="licence">
148 <h2>Licence</h2>
149 <p>
150 log4javascript is licenced under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html"
151 title="Apache License, Version 2.0 (opens in new window)" target="_blank">Apache License,
152 Version 2.0</a>. The Apache website has <a href="http://www.apache.org/foundation/licence-FAQ.html#WhatDoesItMEAN"
153 title="View licence (opens in new window)" target="_blank">more details</a>.
154 </p>
155 <p class="linktotop">
156 <a href="#container">Top</a>
157 </p>
158 </div>
159 <div id="furtherreading">
160 <h2>Further reading</h2>
161 <p>
162 In order to gain an understanding of the ideas behind log4j and therefore log4javascript,
163 I highly recommend reading the <a href="http://logging.apache.org/log4j/docs/manual.html">short
164 introduction to log4j</a> from the log4j website. log4javascript borrows heavily from
165 log4j but does not carry over all its concepts - for example, Filters and Renderers are not
166 implemented.
167 </p>
168 <p>
169 <a href="manual.html">The full log4javascript manual</a>
170 </p>
171 <p class="linktotop">
172 <a href="#container">Top</a>
173 </p>
174 </div>
175 </div>
176 <div id="footer">
177 <span class="externallinkinfo">
178 <strong>NB.</strong> All external links open in a new window.
179 </span>
180 Written by Tim Down. <a href="mailto:tim@log4javascript.org">tim@log4javascript.org</a>
181 <br />
182 log4javascript is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html"
183 title="Apache License, Version 2.0 (opens in new window)" target="_blank">Apache License,
184 Version 2.0</a>
185
186 </div>
187 </div>
188
189 </body>
190</html>