egroupware/phpgwapi/js/jsolait/doc/index.xhtml

94 lines
4.8 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>jsolait 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="./html.css" />
<meta name="author" content="Jan-Klaas Kollhof" />
<meta name="keywords" content="JavaScript, OOP, object oriented programming, OOP in JavaScript, JS, OOP JS, tutorial, prototyping, inheritance, subclassing, data hiding" />
<link rel="stylesheet" type="text/css" href="./highlight.css" />
</head>
<body>
<a name="top" id="top"></a>
<div class="navigationBar">documentation</div>
<div class="menu">
<ul>
<li>
<a href="./tutorial.xhtml">Tutorial</a>
</li>
</ul>
<div class="copyright">copyright © 2004, Jan-Klaas Kollhof</div>
</div>
<div class="content">
<h1>JavaScript o Lait documentation</h1>
Version 1.0<br />
October 2004<br />
<br />
<div class="contentItem"><h2><a href="./tutorial.xhtml">Tutorial</a><a class="bttop" href="#top"></a></h2><div>
This is a good starting point if you have not worked with jsolait before.
</div></div>
<div class="contentItem"><h2>Modules<a class="bttop" href="#top"></a></h2><div>
<h3><a href="./jsolait.xhtml">jsolait</a></h3><div class="indent">
The main module containing the basic jsolait functionality.
</div>
<br />
<h3><a href="./codecs.xhtml">codecs</a></h3><div class="indent">
Provides String encoding and decoding functionalities.
</div>
<h3><a href="./crypto.xhtml">crypto</a></h3><div class="indent">
Provides cryptographic services.
</div>
<h3><a href="./jsonrpc.xhtml">jsonrpc</a></h3><div class="indent">
An implementation of the <a href="http://json-rpc.org" target="_blank">JSON-RPC</a> protocoll.
</div>
<h3><a href="./lang.xhtml">lang</a></h3><div class="indent">
Provides language services. E.g. a JavaScript tokenizer.
</div>
<h3><a href="./stringformat.xhtml">stringformat</a></h3><div class="indent">
This module is automatically loaded with the main module. It provides some powerful string formatting.
</div>
<h3><a href="./urllib.xhtml">urllib</a></h3><div class="indent">
Provides methods to make HTTP requests.
</div>
<h3><a href="./xml.xhtml">xml</a></h3><div class="indent">
Provides XML services.
</div>
<h3><a href="./xmlrpc.xhtml">xmlrpc</a></h3><div class="indent">
An implementation of the <a href="http://xml-rpc.com" target="_blank">XML-RPC</a> protocoll.
</div>
</div></div>
<div class="contentItem"><h2>Usage/Installation<a class="bttop" href="#top"></a></h2><div>
JavaScript o lait was designed to be used in web pages(HTML/SVG) but is not limited to it.
The simplest way to use it is to copy the jsolait folder to your project directory and include the main file into the web page by reference.<br />
In HTML use the script element:<br />
<span class="S51">&lt;script</span><span class="S58"> </span><span class="S53">type</span><span class="S58">=</span><span class="S56">"text/javascript"</span><span class="S58"> </span><span class="S53">src</span><span class="S58">=</span><span class="S56">"./jsolait/init.js"</span><span class="S51">&gt;&lt;/script&gt;</span><br />
In SVG it is similar:<br />
<span class="S51">&lt;script</span><span class="S58"> </span><span class="S53">type</span><span class="S58">=</span><span class="S56">"text/ecmascript"</span><span class="S58"> </span><span class="S53">xlink:href</span><span class="S58">=</span><span class="S56">"./jsolait/init.js"</span><span class="S511">/&gt;</span><br />
<br />
You can also use jsolait with WScript by running the init.js script and pass the script to be executed as a command line argument:<br />
<code>cscript.exe /nologo "c:\path_to_jsolait_folder\init.js" "file://path_to_script\your_script.js"</code><br />
<br />
See <a href="./jsolait.xhtml">jsolait</a> module documentation for customization and requirements.
</div></div>
</div>
</body>
</html>