new /readme structure
This commit is contained in:
rolux
parent
6145b889e5
commit
7302759ab0
11 changed files with 6 additions and 175 deletions
13
readme/index/about.html
Normal file
13
readme/index/about.html
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<h1><b>OxJS — A JavaScript Library for Web Applications</b></h1>
|
||||
|
||||
<p>TL;DR: <b>OxJS</b> is awesome — <a href="https://pan.do/ra#demo">see it in action</a>!</b></p>
|
||||
|
||||
<p><b>OxJS</b> (pronounced oh-ex-jay-ess) is a comprehensive JavaScript library, originally developed for the media archive platform <a href="http://pan.do/ra">pan.do/ra</a>. While it still has bugs, holes, design errors and lots of cruft, some parts of it may already be of interest to a wider audience.</p>
|
||||
|
||||
<p>The core of <b>OxJS</b> is <code>Ox.js</code>, a general-purpose utility library. It <a href="#doc/Ox.loop">embraces</a> <a href="#doc/Ox.forEach">functional</a> <a href="#doc/Ox.map">programming</a>, <a href="#doc/Ox.load">supports modules</a>, <a href="#doc/Ox.getDateInWeek">provides</a> <a href="#doc/Ox.getDayOfTheYear">lots</a> <a href="#doc/Ox.getDaysInMonth">of</a> <a href="#doc/Ox.getDaysInYear">tools</a> <a ref="#doc/Ox.getISODate">to</a> <a href="#doc/Ox.getISOWeek">deal</a> <a href="#doc/Ox.parseDate">with</a> <a href="#doc/Ox.formatDate">dates</a>, <a href="#doc/Ox.atanh">has</a> <a href="#doc/Ox.deg">all</a> <a href="#doc/Ox.limit">the</a> <a href="#doc/Ox.mod">missing</a> <a href="#doc/Ox.sign">math</a> <a href="#doc/Ox.trunc">methods</a> (<a href="#doc/Ox.getBearing">plus</a> <a href="#doc/Ox.getCircle">some</a> <a href="#doc/Ox.getDistance">more</a> <a href="#doc/Ox.getLine">for</a> <a href="#doc/Ox.getDegreesPerMeter">geographic</a> <a href="#doc/Ox.getLatLngByXY">coordinates</a>) <a href="#doc/Ox.pad">and</a> <a href="#doc/Ox.repeat">helper</a> <a href="#doc/Ox.startsWith">functions</a> <a href="#doc/Ox.truncate">for</a> <a href="#doc/Ox.wordwrap">strings</a> <a href="#doc/Ox.escapeRegExp">and regular expressions</a>, <a href="#doc/Ox.isEmpty">fixes</a> <a href="#doc/Ox.isInt">type</a> <a href="#doc/Ox.typeOf">detection</a> <a href="#doc/Ox.isEqual">and equality testing</a>, <a href="#doc/Ox.addLinks">includes</a> <a href="#doc/Ox.encodeHTMLEntities">utilities</a> <a href="#doc/Ox.highlight">to</a> <a href="#doc/Ox.normalizeHTML">handle</a> <a href="#doc/Ox.sanitizeHTML">HTML</a>, <a href="#doc/Ox.$">the DOM</a> <a href="#doc/Ox.getJSON">and</a> <a href="#doc/Ox.getJSONC">remote</a> <a href="#doc/Ox.getJSONP">requests</a>, 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>, <a href="#doc/Ox.api">and</a> <a href="#doc/Ox.getset">does</a> <a href="#doc/Ox.getAsync">many</a> <a href="#doc/Ox.getFile">other</a> <a href="#doc/Ox.encodeDeflate">cool</a> <a href="#doc/Ox.encodeUTF8">things</a>.</p>
|
||||
|
||||
<p>Then there are modules, most notably <code>Ox.UI</code>, which makes it super simple to write complex, desktop-class web applications for HTML5-compliant browsers. <code>Ox.UI</code> has tons of highly customizable and <a href="#doc/Ox.Theme">fully themable</a> widgets: <a href="#doc/Ox.ArrayInput">all</a> <a href="#doc/Ox.DateInput">the</a> <a href="#doc/Ox.FileInput">form</a> <a href="#doc/Ox.ObjectInput">elements</a> <a href="#doc/Ox.SelectInput">you</a> <a href="#doc/Ox.Range">ever</a> <a href="#doc/Ox.Spreadsheet">wanted</a>, <a href="#doc/Ox.MainMenu">menus</a> that actually work, resizable <a href="#doc/Ox.SplitPanel">panels</a> and <a href="#doc/Ox.Dialog">dialogs</a>, <a href="#doc/Ox.IconList">lists</a> and <a href="#doc/Ox.TextList">tables</a> that can hold millions of items, <a href="#doc/Ox.Map">maps</a> and <a href="#doc/Ox.Calendar">calendars</a> done right, a feature-rich <a href="#doc/Ox.VideoPlayer">video player</a>, <a href="#doc/Ox.Chart">and</a> <a href="#doc/Ox.SourceViewer">lots</a> <a href="#doc/Ox.SyntaxHighlighter">more</a>. These widgets allow you to 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 the exact same API as a <a href="#doc/Ox.JQueryElement">jQuery DOM object</a>. But <code>Ox.UI</code> also provides the logic to bring these elements together, including custom events, <a href="#doc/Ox.Keyboard">keyboard</a> <a href="#doc/Ox.Focus">focus</a>, <a href="#doc/Ox.API">remote API discovery</a> and <a href="#doc/Ox.URL">client-side URL handling</a>. As long as your backend speaks JSON, it doesn't have to speak any HTML whatsoever.</p>
|
||||
|
||||
<p>Among the other modules, <code>Ox.Unicode</code> helps with <a href="#doc/Ox.toASCII">converting</a> or <a href="#doc/Ox.sortASCII">sorting</a> unicode strings, <code>Ox.Image</code> can do <a href="#doc/Ox.Image">basic image manipulation</a>, including steganography, and <code>Ox.Geo</code> comes into play if you're dealing with <a href="#doc/Ox.getCountryByName">geographical data</a>, or want to use a <a href="#">really nice set</a> of <a href="#doc/Ox.getFlagByCountryCode">flag icons</a>.</p>
|
||||
|
||||
<p>Finally, there is a small but growing number of <a href="#readme">articles</a> and <a href="#examples">tutorials</a>, and extensive (albeit still incomplete) <a href="#doc">documentation</a>. If you want to get involved, file bugs or submit patches, please head over to the <a href="#development">development</a> section. Your feedback is welcome!</p>
|
||||
17
readme/index/development.html
Normal file
17
readme/index/development.html
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
<h1><b>Development</b></h1>
|
||||
|
||||
<p>Source code: <a href="https://trac.oxjs.org/browser"><code>trac.oxjs.org/browser</code></a></p>
|
||||
|
||||
<p>Open issues: <a href="https://trac.oxjs.org/report"><code>trac.oxjs.org/report</code></a></p>
|
||||
|
||||
<p>Bug reports and feature requests: <a href="https://trac.oxjs.org/newticket"><code>trac.oxjs.org/newticket</code></a></p>
|
||||
|
||||
<p>Mailing list: <a href="https://mailb.org/cgi-bin/mailman/listinfo/oxjs-dev"><code>mailb.org/cgi-bin/mailman/listinfo/oxjs-dev</code></a></p>
|
||||
|
||||
<p>E-mail: <a href="mailto:oxjs@oxjs.org"><code>oxjs@oxjs.org</code></a></p>
|
||||
|
||||
<p>IRC: <a href="irc://irc.freenode.net#oxjs"><code>irc.freenode.net#oxjs</code></a></p>
|
||||
|
||||
<p>Twitter: <a href="https://twitter.com/#!/OxJS"><code>@OxJS</code></a></p>
|
||||
|
||||
<p>Postcards: <code><a href="https://0x2620.org">Ox2620</a>, Memhardtstrasse 2, 10178 Berlin, Germany</code></p>
|
||||
3
readme/index/documentation.html
Normal file
3
readme/index/documentation.html
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<h1><b>Documentation</b></h1>
|
||||
<p>Generated with <a href="#doc/Ox.doc"><code>Ox.doc</code></a>.</p>
|
||||
<p>Please note that some sections and entries may still be incomplete, incorrect or in flux. In case you find any glaring errors, <a href="#development">let us know</a>.</p>
|
||||
35
readme/index/download.html
Normal file
35
readme/index/download.html
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
<h1><b>Download</b></h1>
|
||||
<p>{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 <a href="https://oxjs.org/downloads/OxJS.latest.source.tar.gz"><code>OxJS.latest.source.tar.gz</code></a>{size.source}.</p>
|
||||
<p>Start with <code>OxJS/index.html</code>. It's this website.</p>
|
||||
<br>
|
||||
<h2><b>Build</b></h2>
|
||||
<p>Minified production version.</p>
|
||||
<p>Download <a href="https://oxjs.org/downloads/OxJS.latest.build.tar.gz"><code>OxJS.latest.build.tar.gz</code></a>{size.build}.</p>
|
||||
<p>Or get <code>Ox.js</code> only: <a href="https://oxjs.org/oxjs/build/Ox.js"><code>Ox.js</code></a>{size.minified}.</p>
|
||||
<br>
|
||||
<h2><b>Getting Started</b></h2>
|
||||
<pre><!DOCTYPE HTML>
|
||||
<html>
|
||||
<head>
|
||||
<script type="text/javascript" src="OxJS/build/Ox.js"></script>
|
||||
<script>
|
||||
Ox.load(function() {
|
||||
// Your code here.
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
<body></body>
|
||||
</html></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, <a href=\"http://en.wikipedia.org/wiki/GNU_General_Public_License\">GPL</a>/<a href=\"http://en.wikipedia.org/wiki/MIT_License\">MIT</a>. You can pick either. In a nutshell, the former says no derived work may be more restrictive, while the latter avoids to make that restriction.</p>
|
||||
3
readme/index/examples.html
Normal file
3
readme/index/examples.html
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<h1><b>Examples</b></h1>
|
||||
<p>A growing list of annotated examples. You're invited to <a href="#development">contribute</a>.</p>
|
||||
<p>For a comprehensive demo of <code>Ox.UI</code>, take a look at <a href="https://pan.do/ra#demo">pan.do/ra</a>.</p>
|
||||
2
readme/index/readme.html
Normal file
2
readme/index/readme.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<h1><b>Readme</b></h1>
|
||||
<p>The missing blog. The missing FAQ. The missing manual.</p>
|
||||
Loading…
Add table
Add a link
Reference in a new issue