From 679dc34dfa24acdd206c969a6549e04584447a82 Mon Sep 17 00:00:00 2001 From: rolux Date: Mon, 25 Jun 2012 11:28:55 +0200 Subject: [PATCH] update examples --- .../images/image_manipulation/js/example.js | 18 ++++---- examples/images/steganography/js/example.js | 43 +++++++++---------- examples/lists/json/js/example.js | 2 +- 3 files changed, 29 insertions(+), 34 deletions(-) diff --git a/examples/images/image_manipulation/js/example.js b/examples/images/image_manipulation/js/example.js index 6b1bbc2e..e96f6464 100644 --- a/examples/images/image_manipulation/js/example.js +++ b/examples/images/image_manipulation/js/example.js @@ -4,7 +4,7 @@ Load the image module. Ox.load('Image', function() { /* - Load a sample image (about which you can read more on + Load a sample image (which has its own entry in Wikipedia). */ Ox.Image('png/lenna256.png', function(image) { @@ -52,8 +52,8 @@ Ox.load('Image', function() { match = value.match(/^(\w+)\((.*?)\)$/), fn = match[1], args; /* - The map method takes a function as its argument, which - we can't JSON.parse, but have to eval. + The `map` method takes a function as its argument, which we can't + `JSON.parse`, but have to `eval`. */ try { args = JSON.parse('[' + match[2] + ']'); @@ -61,21 +61,19 @@ Ox.load('Image', function() { args = [eval('f = ' + match[2])]; } /* - The src and encode methods are - asynchronous and take a callback function. + The `src` and `encode` methods are asynchronous and take a callback + function. */ if (fn == 'src' || fn == 'encode') { image[fn].apply(null, args.concat(function(image) { $image.attr({src: image.src()}); })); /* - The decode method is asynchronous too, and its callback - function gets passed a string. + The `decode` method is asynchronous too, and its callback function + gets passed a string. */ } else if (fn == 'decode') { - image[fn].apply(null, args.concat(function(str) { - alert(str); - })); + image[fn].apply(null, args.concat(alert)); /* All other methods simply return the image. */ diff --git a/examples/images/steganography/js/example.js b/examples/images/steganography/js/example.js index a18abe5c..55831aed 100644 --- a/examples/images/steganography/js/example.js +++ b/examples/images/steganography/js/example.js @@ -1,19 +1,16 @@ /* -Ox.Image provides a pair of methods, encode and -decode, which can be used for -steganography, i.e. to -add a hidden message to an image.

-The signature of the encode function is -image.encode(message, deflate, mode, callback). -deflate turns deflate-compression on or off, and mode -determines which bits of the image the message will be written to — but -for most purposes, the default values (true and 0) -are fine, so deflate and mode can be omitted.
-
-In this example, we demonstrate a valid use case for deflate and -mode: To encode an decoy message (a line of text), which will be -relatively easy to detect, and then the the actual message, (another image, -itself containing another line of text), which will be harder to detect. +Ox.Image provides a pair of methods, `encode` and `decode`, which can be used +for steganography, i.e. +to add a hidden message to an image.

The signature of the `encode` +function is `image.encode(message, deflate, mode, callback)`. `deflate` turns +deflate-compression on or off, and `mode` determines which bits of the image the +message will be written to — but for most purposes, the default values +(`true` and `0`) are fine, so `deflate` and `mode` can be omitted. + +In this example, we demonstrate a valid use case for `deflate` and `mode`: To +encode an decoy message (a line of text), which will be relatively easy to +detect, and then the the actual message, (another image, itself containing +another line of text), which will be harder to detect. */ 'use strict'; @@ -33,14 +30,14 @@ Ox.load('Image', function() { /* So we first encode two lines text into two images, by writing them bit by - bit (without compression, deflate = false), into the least - significant bit of each 8-bit RGB value (mode = 1). Then we - encode one image into the other: We take the (deflate-compressed, - deflate = true) data URL of the source image and flip, if - needed, the second least significant bit of each RGB value of the target - image, so that the number of bits set to 1, modulo 2 (for example: 10101010 - -> 0), is the bit we're encoding (mode = -1). As the least - significant bit remains untouched, this will preserve the encoded text. + bit (without compression, `deflate = false`), into the least significant bit + of each 8-bit RGB value (`mode = 1`). Then we encode one image into the + other: We take the (deflate-compressed, `deflate = true`) data URL of the + source image and flip, if needed, the second least significant bit of each + RGB value of the target image, so that the number of bits set to 1, modulo 2 + (for example: 10101010 -> 0), is the bit we're encoding (`mode = -1`). As + the least significant bit remains untouched, this will preserve the encoded + text. */ function encode(callback) { status('Load iceland.png'); diff --git a/examples/lists/json/js/example.js b/examples/lists/json/js/example.js index 33f7c9e2..9d247363 100644 --- a/examples/lists/json/js/example.js +++ b/examples/lists/json/js/example.js @@ -4,7 +4,7 @@ This is probably the easiest way of displaying a complex data structure... Ox.load('UI', function() { - Ox.getJSON(Ox.PATH + '/Ox.Geo/json/Ox.Geo.json', function(data) { + Ox.getJSON(Ox.PATH + 'Ox.Geo/json/Ox.Geo.json', function(data) { Ox.TreeList({data: data}).appendTo(Ox.$body);