0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

update site sections

Browse source
This commit is contained in:
rolux 2012-04-07 12:41:39 +02:00
parent d4a7e07870
commit 14486398c2
3 changed files with 64 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
readme/html/_about.html Normal file
View file

@ -0,0 +1,13 @@
<h1>OxJS &mdash; A JavaScript Library for Web Applications</h1>
<p>TL;DR: <b>OxJS</b> will be out soon. But it already works. <a href="https://0xDB.org">See it in action</a>!</b></p>
<p><b>OxJS</b> is a new JavaScript library. It was originially developed as part of <a href="pan.do/ra">pan.do/ra</a>, and is currently awaiting its first proper release. While it still has bugs, holes, design errors and lots of cruft, some parts of it may already be useful for a more general audience.</p>
<p>The core of <b>OxJS</b> is <code>Ox.js</code>, a general-purpose utility library (think underscore.js, but quite different). It provides <a href="#">lots</a> <a href="#">of</a> <a href="#">tools</a> <a href="#">for</a> <a href="#">dealing</a> <a href="#">with</a> <a href="#doc/Ox.formatDate">dates</a>, <a href="#doc/Ox.asinh">has</a> <a href="#doc/Ox.deg">all</a> <a href="#doc/Ox.log">the</a> <a href="#doc/Ox.mod">missing</a> <a href="#doc/Ox.rad">Math</a> <a href="#doc/Ox.sinh">functions</a> (<a href="#">plus</a> <a href="#">some</a> <a href="#">for</a> <a href="#">geographic</a> <a href="#">coordinates</a>), methods like <a href="#doc/Ox.range">range</a> or <a href="#doc/Ox.sub">sub</a> for those who like Python (and even <a href="#doc/Ox.forEach">some</a> <a href="#doc/Ox.loop">options</a> for those who never want to write a <code>for</code> loop again), can <a href="#doc/Ox.tokenize">tokenize</a> and <a href="#doc/Ox.minify">minify</a> JavaScript, comes with its own <a href="#doc/Ox.doc">documentation format</a>, including <a href="#doc/Ox.test">inline tests</a>, and can do about <a href="#readme/23_cool_things_you_can_do_with_oxjs">23 other cool things</a>.</p>
<p>Then there are modules, most notably <code>Ox.UI</code>, a user interface library for HTML5-compliant browsers (think YUI, but again rather different). <code>Ox.UI</code> has tons of widgets: <a href="#">all</a> <a href="#">the</a> <a href="#">form</a> <a href="#">elements</a> <a href="#">you</a> <a href="#">ever</a> <a href="#">wanted</a>, resizable <a href="#doc/Ox.SplitPanel">panels</a> and <a href="#doc/Ox.Dialog">dialogs</a>, <a href="#doc/Ox.MainMenu">menus</a> that actually work, <a href="#doc/Ox.IconList">lists</a> and <a href="#doc/Ox.TextList">tables</a> that can hold a million items, <a href="#doc/Ox.Map">maps</a> and <a href="#doc/Ox.Calendar">calendars</a> done right, and a great <a href="#doc/Ox.VideoPlayer">video player</a>. All these widgets are designed to that you can focus on your application and argue less with the DOM. And if you need to, <a href="#doc/Ox.Element">each of them</a> provides, by virtue of <a href="#">parasitical inheritance</a>, the exact same API as a <a href="#Ox.JQueryElement">jQuery DOM object</a>. But <code>Ox.UI</code> also provides a framework to bring these elements together, including <a href="#">custom</a> <a href="#">events</a>, <a href="#">keyboard</a> <a href="#">focus</a>, remote <a href="#">API</a> discovery and client-side <a href="#">URL</a> handling. It is ideal for real applications with back-ends that speak JSON and don't serve any HTML beyond <code>&lt;body&gt;&lt;/body&gt;</code>.</p>
<p>Among the other modules, <code>Ox.Unicode</code> helps with sorting, <code>Ox.Image</code> can do steganography, and <code>Ox.Geo</code> is great if you're dealing with geographical data (or want to use a really nice set of flag icons).</p>
<p>Finally, there is a small but growing number of <a href="#">articles</a> and <a href="#">tutorials</a>, and extensive <a href="#">documentation</a> (which, needless to say, may still be incomplete, and sometimes even incorrect). If you want to get involved, file bugs, submit patches or give any other kind of feedback, please head over to the <a href="#development">development</a> section.</p>

17
readme/html/_development.html Normal file
View file

@ -0,0 +1,17 @@
<h1><b>Development</b></h1>
<p>Source code: &nbsp;<a href="https://trac.oxjs.org/browser"><code>trac.oxjs.org/browser</code></a></p>
<p>Open issues: &nbsp;<a href="https://trac.oxjs.org/report"><code>trac.oxjs.org/report</code></a></p>
<p>Bug reports and feature requests: &nbsp;<a href="https://trac.oxjs.org/newticket"><code>trac.oxjs.org/newticket</code></a></p>
<p>Mailing list: &nbsp;<a href="https://mailb.org/cgi-bin/mailman/listinfo/oxjs"><code>mailb.org/cgi-bin/mailman/listinfo/oxjs-dev</code></a></p>
<p>E-mail: &nbsp;<a href="mailto:oxjs@oxjs.org"><code>oxjs@oxjs.org</code></a></p>
<p>IRC: &nbsp;<a href="irc:freenode.net/#oxjs"><code>freenode.net/#oxjs</code></a></p>
<p>Twitter: &nbsp;<a href="https://twitter.com/#!/0x2620"><code>@0x2620</code></a></p>
<p>Postcards: &nbsp;<code><a href="https://0x2620.org">Ox2620</a>, Memhardtstrasse 2, 10178 Berlin, Germany</code></p>

34
readme/html/_downloads.html Normal file
View file

@ -0,0 +1,34 @@
<h1><b>Downloads</b></h1>
<p>Please note that these are a pre-release versions. {version}</p>
<br>
<h2><b>Source</b></h2>
<p>Development version, including everything but the kitchen sink.</p>
<p>
Check it out and build it yourself (you'll need <a href="https://wiki.0x2620.org/wiki/python-ox"><code>python-ox</code></a>):<pre>
$ bzr branch http://code.0x2620.org/oxjs
$ tools/build/build.py</pre>
</p>
<p>Or download &nbsp;<a href="https://oxjs.org/downloads/OxJS.latest.build.tar.gz"><code>OxJS.latest.source.tar.gz</code></a></p>
<p>Start with &nbsp;<code>OxJS/index.html</code>. It's this website.</p>
<br>
<h2><b>Build</b></h2>
<p>Minified production version.</p>
<p>Download &nbsp;<a href="https://oxjs.org/downloads/OxJS.latest.build.tar.gz"><code>OxJS.latest.build.tar.gz</code></a>, or get <code>Ox.js</code> only: &nbsp;<a href="https://oxjs.org/oxjs/build/Ox.js"><code>Ox.js</code></a></p>
<br>
<h2><b>Getting Started</b></h2>
<pre>&lt;!DOCTYPE HTML&gt;
&lt;html&gt;
&lt;head&gt;
&lt;script type="text/javascript" src="OxJS/build/Ox.js"&gt;&lt;/script&gt;
&lt;script&gt;
Ox.load(function() {
// Your code here.
});
&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;&lt;/body&gt;
&lt;/html&gt;</pre>
<p>For the development version, use <code>OxJS/dev/Ox.js</code> instead. And to include <code>Ox.UI</code>, start with <code>Ox.load('UI', function() { ... })</code>.</p>
<br>
<h2><b>License</b></h2>
<p>Dual-licensed, GPL/MIT.</p>