From 7302759ab01a274ff608f309eca8a48ae8a60a01 Mon Sep 17 00:00:00 2001 From: rolux Date: Wed, 20 Jun 2012 11:06:15 +0200 Subject: [PATCH] new /readme structure --- examples/cities/js/example.js | 6 +- readme/html/OxDoc.html | 150 ------------------ readme/html/ParasiticalInheritance.html | 23 --- readme/{html/_about.html => index/about.html} | 0 .../development.html} | 0 .../documentation.html} | 0 .../_download.html => index/download.html} | 0 .../_examples.html => index/examples.html} | 0 .../{html/_readme.html => index/readme.html} | 0 readme/{html => }/test1.html | 2 + readme/{html => }/test2.html | 0 11 files changed, 6 insertions(+), 175 deletions(-) delete mode 100644 readme/html/OxDoc.html delete mode 100644 readme/html/ParasiticalInheritance.html rename readme/{html/_about.html => index/about.html} (100%) rename readme/{html/_development.html => index/development.html} (100%) rename readme/{html/_documentation.html => index/documentation.html} (100%) rename readme/{html/_download.html => index/download.html} (100%) rename readme/{html/_examples.html => index/examples.html} (100%) rename readme/{html/_readme.html => index/readme.html} (100%) rename readme/{html => }/test1.html (99%) rename readme/{html => }/test2.html (100%) diff --git a/examples/cities/js/example.js b/examples/cities/js/example.js index e5ad3f9c..6d7582cf 100644 --- a/examples/cities/js/example.js +++ b/examples/cities/js/example.js @@ -48,7 +48,8 @@ Ox.load({UI: {showScreen: true}, Geo: {}}, function() { latSize = Math.sqrt(area) / Ox.EARTH_CIRCUMFERENCE * 360, lngSize = Math.sqrt(area) * Ox.getDegreesPerMeter(data.latitude); /* - Our city object will look like this:
+            Our city object will look like this:
+            
             {
                 "area": 1460851200,
                 "capital": false,
@@ -65,7 +66,8 @@ Ox.load({UI: {showScreen: true}, Geo: {}}, function() {
                 "region": "Asia, Eastern Asia, China",
                 "south": 31.050547083986842,
                 "west": 121.25731130524166
-            }

+            }
+
Obviously, in a real-world scenario, you would make sure that the data already comes in this form. */ diff --git a/readme/html/OxDoc.html b/readme/html/OxDoc.html deleted file mode 100644 index e6bd40ff..00000000 --- a/readme/html/OxDoc.html +++ /dev/null @@ -1,150 +0,0 @@ - -

Ox.doc - A JavaScript Documentation Language

- -

At its core, Ox.doc is list of lines like this:

-
//@ name <type> summary
-

...

-
/*@
-name <type> summary
-    Longer description
-    that may contain HTML.
-@*/
-
- -

If you are documenting an object with properties, these lines can be nested:

-
/*@
-My.team <object> Some sports team
-    name <string> The team's name
-    lastMatch <object> The most recent result
-        for <number> Goals for
-        against <number> Goals against
-    won <boolean> If true, last match was a win
-@*/
- -

The same goes for functions and events:

-
/*@
-My.readURL <function> Reads data from a remote URL
-    (url, callback) -> <o> Request handler
-        cancel <function> The handler's only property. Takes no arguments. Cancels the request.
-    url <string> Remote URL
-    callback <function> Callback function
-        result <object> Result object
-            status <number> HTTP status code
-            data <string> Data read from URL, or empty string
-    stalled <event> Fires when the connection is stalled
-        reason <string> Potential cause of the network problem
-@*/
- - -

- -
/*@
-foo <o> Demo object
-    array     <a> An array (and we don't care about the type of its elements)
-    boolean   <b> True or false
-    date      <d> Date object
-    element   <e> DOM element
-    function  <f> A function
-    number    <n> A number
-    object    <o> An object
-    regexp    <r> Regular Expression
-    string    <s> A string
-    undefined <u> undefined
-        Makes most sense for the result of a function that doesn't return,
-        or as the last of multiple types, to indicate a property may be missing
-    any_value <*> anything
-    event     <!> A custom event
-    example1  <[n]|u> An array of numbers, or undefined
-    example2  <s|'foo'> A string, default 'foo'
-@*/
-
- -

foo bar

- -
//@ My.TYPES <number> Request timeout, in seconds
-My.REQUEST_TIMEOUT = 60;
-try it out - -

foo bar

- -
/*@
-My.getProtocol <function> Returns the protocol part of a URL
-    (url) -> <string> Protocol, like "https", otherwise ""
-    url <string> Just some URL
-@*/
-My.getProtocol = function(url) {
-    var match = url.match(/^(.+):\/\//);
-    return match ? match[1] : '';
-};
- -

foo bar

- -
/*@
-My.readURL <f> Reads data from a remote URL
-    (url, callback) -> <o> Request handler
-    (url, options, callback) -> <o> Request handler
-        cancel <f> Function to cancel the request
-    url <s> Remote URL
-    options <o> Optional config object
-        timeout <n|60> Timeout in seconds
-        type <s|'GET'> Request type ('GET', 'POST', 'PUT' or 'DELETE')
-    callback <f> Callback function
-        result <o> Result object
-            status <n> HTTP status code
-            data <s> Data read from URL, or empty string
-@*/
-My.readURL = function(url, options, callback) {
-    if (arguments.length == 2) {
-        callback = options;
-        options = {timeout: 60, type: 'GET'};
-    }
-};
-try it out - - -

foo bar

- -
/*@
-My.Request <o> Remote request utility
-@*/
-My.Request = (function()
-    // ...
-    r
-)();
\ No newline at end of file diff --git a/readme/html/ParasiticalInheritance.html b/readme/html/ParasiticalInheritance.html deleted file mode 100644 index 72493710..00000000 --- a/readme/html/ParasiticalInheritance.html +++ /dev/null @@ -1,23 +0,0 @@ -

Parasitical Inheritance

- -

This will be a text about Parasitical Inheritance

- -

-Ox.IconList = function(options, self) {
-    self = self || {};
-    var that = Ox.Element({}, self)
-            .defaults({
-                ...
-                pageLength: 100,
-                selected: [],
-                size: 128,
-                sort: [],
-                ...
-            })
-            .options(options || {});
-
-    ...
-
-    return that;
-}
-

diff --git a/readme/html/_about.html b/readme/index/about.html similarity index 100% rename from readme/html/_about.html rename to readme/index/about.html diff --git a/readme/html/_development.html b/readme/index/development.html similarity index 100% rename from readme/html/_development.html rename to readme/index/development.html diff --git a/readme/html/_documentation.html b/readme/index/documentation.html similarity index 100% rename from readme/html/_documentation.html rename to readme/index/documentation.html diff --git a/readme/html/_download.html b/readme/index/download.html similarity index 100% rename from readme/html/_download.html rename to readme/index/download.html diff --git a/readme/html/_examples.html b/readme/index/examples.html similarity index 100% rename from readme/html/_examples.html rename to readme/index/examples.html diff --git a/readme/html/_readme.html b/readme/index/readme.html similarity index 100% rename from readme/html/_readme.html rename to readme/index/readme.html diff --git a/readme/html/test1.html b/readme/test1.html similarity index 99% rename from readme/html/test1.html rename to readme/test1.html index 65bf7641..d7fe0a39 100644 --- a/readme/html/test1.html +++ b/readme/test1.html @@ -6,6 +6,8 @@
blockquote
+test + 

 /*
 
diff --git a/readme/html/test2.html b/readme/test2.html
similarity index 100%
rename from readme/html/test2.html
rename to readme/test2.html