Skip to content
This repository was archived by the owner on Jan 4, 2021. It is now read-only.

Commit ebdb474

Browse files
author
Francois-Xavier Gentilhomme
committed
v1.0.10 Documentation links update
1 parent 6fde7ba commit ebdb474

File tree

33 files changed

+675
-350
lines changed

33 files changed

+675
-350
lines changed

Gruntfile.js

Lines changed: 20 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,20 @@ module.exports = function (grunt) {
2828
samples: 'samples',
2929
test_results: 'test_results'
3030
},
31+
connect: {
32+
options: {
33+
port: 9000,
34+
// Change this to '0.0.0.0' to access the server from outside.
35+
hostname: 'localhost'
36+
},
37+
samples: {
38+
options: {
39+
open: true,
40+
keepalive: true,
41+
base: '<%= project.resources %>/<%= project.samples %>'
42+
}
43+
}
44+
},
3145
mochaTest: {
3246
options: {
3347
timeout: 2000,
@@ -183,38 +197,6 @@ module.exports = function (grunt) {
183197
dest: '<%= project.tmp %>',
184198
src: ['theme.json']
185199
}]
186-
},
187-
samples: {
188-
files: [{
189-
expand: true,
190-
dot: true,
191-
cwd: '<%= project.resources %>/<%= project.samples %>',
192-
dest: '<%= project.dist %>/<%= project.samples %>',
193-
src: ['**']
194-
}, {
195-
expand: true,
196-
dot: true,
197-
flatten: true,
198-
cwd: '<%= bowerrc.directory %>',
199-
dest: '<%= project.dist %>/<%= project.samples %>/lib',
200-
src: [
201-
'cryptojslib/components/core-min.js',
202-
'cryptojslib/components/x64-core-min.js',
203-
'cryptojslib/components/sha512-min.js',
204-
'cryptojslib/components/hmac-min.js',
205-
'q/q.js'
206-
]
207-
}, {
208-
expand: true,
209-
dot: true,
210-
flatten: true,
211-
cwd: '<%= project.dist %>',
212-
dest: '<%= project.dist %>/<%= project.samples %>/lib',
213-
src: [
214-
'myscript.min.js',
215-
'myscript.min.js.map'
216-
]
217-
}]
218200
}
219201
},
220202
yuidoc: {
@@ -281,7 +263,7 @@ module.exports = function (grunt) {
281263
},
282264
files: [{
283265
expand: true,
284-
cwd: '<%= project.dist %>/<%= project.samples %>/',
266+
cwd: '<%= project.resources %>/<%= project.samples %>/',
285267
src: ['**'],
286268
dest: '<%= project.samples %>/'
287269
}, {
@@ -301,7 +283,7 @@ module.exports = function (grunt) {
301283
},
302284
files: [{
303285
expand: true,
304-
cwd: '<%= project.dist %>/<%= project.samples %>/',
286+
cwd: '<%= project.resources %>/<%= project.samples %>/',
305287
src: ['**'],
306288
dest: '<%= project.samples %>/'
307289
}, {
@@ -336,10 +318,13 @@ module.exports = function (grunt) {
336318
'jshint:default',
337319
'test',
338320
'build',
339-
'copy:samples',
340321
'concurrent:release'
341322
]);
342323

324+
grunt.registerTask('samples', [
325+
'connect'
326+
]);
327+
343328
grunt.registerTask('test', [
344329
'test-unit'
345330
]);

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* **Result tree parsing**: The recognition result tree is exposed and fully traversable.
1717
* **Typesetting (coming soon)**: Replace ink with digital equivalent, whether it is text, music, shapes or mathematical expressions.
1818

19-
Learn more on MyScriptJS in the [Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/) and [API Reference Guide](http://myscript.github.io/MyScriptJS/api-reference/).
19+
Learn more on MyScriptJS in the [Developer Guide](http://doc.myscript.com/MyScriptJS/1.0/index.html) and [API Reference Guide](http://doc.myscript.com/MyScriptJS/1.0/reference/index.html).
2020

2121

2222
## Installation

bower.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "myscript",
3-
"version": "1.0.9",
3+
"version": "1.0.10",
44
"main": "./dist/myscript.js",
5-
"description": "MyScriptJS is a free and open-source JavaScript library providing the easiest way to use MyScript Cloud handwriting recognition in your web app",
5+
"description": "The JavaScript library for the MyScript Cloud recognition service",
66
"keywords": [
77
"myscript",
88
"javascript",

dist/myscript.js

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/myscript.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/myscript.min.js

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/myscript.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "myscript",
3-
"version": "1.0.9",
3+
"version": "1.0.10",
44
"main": "./dist/myscript.js",
5-
"description": "MyScriptJS is a free and open-source JavaScript library providing the easiest way to use MyScript Cloud handwriting recognition in your web app",
5+
"description": "The JavaScript library for the MyScript Cloud recognition service",
66
"keywords": [
77
"myscript",
88
"javascript",
@@ -29,6 +29,7 @@
2929
"grunt-contrib-clean": "0.6.x",
3030
"grunt-contrib-compress": "0.13.x",
3131
"grunt-contrib-concat": "0.5.x",
32+
"grunt-contrib-connect": "0.10.x",
3233
"grunt-contrib-copy": "0.7.x",
3334
"grunt-contrib-jshint": "0.10.x",
3435
"grunt-contrib-uglify": "0.6.x",

resources/samples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the [MyScript](www.myscript.com) JavaScript framework.
44

5-
Learn more in the [Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html) and the [API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html).
5+
Learn more in the [Developer Guide](http://doc.myscript.com/MyScriptJS/1.0/index.html) and the [API Reference](http://doc.myscript.com/MyScriptJS/1.0/reference/index.html).
66

77
## Installation
88

resources/samples/analyzer/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the [MyScript](www.myscript.com) JavaScript framework.
44

5-
Learn more in the [Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html) and the [API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html).
5+
Learn more in the [Developer Guide](http://doc.myscript.com/MyScriptJS/1.0/index.html) and the [API Reference](http://doc.myscript.com/MyScriptJS/1.0/reference/index.html).
66

77
## Installation
88

@@ -107,7 +107,7 @@ Besides, the pointerId variable needs to be added: Its role is make sure that ev
107107
</html>
108108
```
109109

110-
### Create a [Renderer](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRenderer.html)
110+
### Create a [Renderer](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/AnalyzerRenderer.html)
111111

112112
You need to create a renderer to draw strokes on your canvas. To do so, provide the renderer with canvas context (size, background, etc.) and ink coordinates.<br>The renderer that you define depends on the type of recognition you want to achieve.
113113

@@ -157,9 +157,9 @@ You need to create a renderer to draw strokes on your canvas. To do so, provide
157157
```
158158

159159

160-
### Create a [InkManager](http://myscript.github.io/MyScriptJS/api-reference/classes/InkManager.html)
160+
### Create a [InkManager](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/InkManager.html)
161161

162-
You need to build a stroker to catch and store the drawn strokes. The stroker will transform them into proper [MyScript Strokes](http://myscript.github.io/MyScriptJS/api-reference/classes/Stroke.html) to use them as input components for the recognition process. Note that the undo/redo feature is not possible without a stroker.
162+
You need to build a stroker to catch and store the drawn strokes. The stroker will transform them into proper [MyScript Strokes](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/Stroke.html) to use them as input components for the recognition process. Note that the undo/redo feature is not possible without a stroker.
163163

164164
```javascript
165165
(function() {
@@ -211,7 +211,7 @@ You need to build a stroker to catch and store the drawn strokes. The stroker wi
211211
})();
212212
```
213213

214-
### Create a [Recognizer](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html)
214+
### Create a [Recognizer](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/AnalyzerRecognizer.html)
215215

216216
You need to create the last object, namely the recognizer. Its role is to manage the recognition within MyScript JS by sending requests and receiving responses to and from MyScript Cloud. The recognizer that you define depends on the type of recognition you want to achieve.
217217

@@ -227,7 +227,7 @@ var analyzerRecognizer = new MyScript.AnalyzerRecognizer();
227227

228228
### Launch the recognition
229229

230-
To launch the recognition process, gather your input components and call the method [`doSimpleRecognition`](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition).<br>
230+
To launch the recognition process, gather your input components and call the method [`doSimpleRecognition`](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/AnalyzerRecognizer.html#method_doSimpleRecognition).<br>
231231
Reminder: The `applicationKey` and the `hmacKey` are generated at the very beginning.<br>
232232
The variable `instanceId` is the session identifier: It is used below to check that you are still working on the same session.
233233

@@ -248,10 +248,10 @@ function doRecognition () {
248248

249249
### Get the result
250250

251-
Every [`doSimpleRecognition`](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition) method returns [Promise](https://github.com/domenic/promises-unwrapping/blob/master/README.md), so you can directly access the output using resolve process. For every recognition type, the result contains the `instanceId` and the recognition document, here a [AnalyzerDocument](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerDocument.html).
251+
Every [`doSimpleRecognition`](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/AnalyzerRecognizer.html#method_doSimpleRecognition) method returns [Promise](https://github.com/domenic/promises-unwrapping/blob/master/README.md), so you can directly access the output using resolve process. For every recognition type, the result contains the `instanceId` and the recognition document, here a [AnalyzerDocument](http://doc.myscript.com/MyScriptJS/1.0/reference/index.htmlclasses/AnalyzerDocument.html).
252252
For more information on output objects, please refer to the
253-
[API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html) and
254-
[Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html).
253+
[API Reference](http://doc.myscript.com/MyScriptJS/1.0/reference/index.html) and
254+
[Developer Guide](http://doc.myscript.com/MyScriptJS/1.0/index.html).
255255

256256
```javascript
257257
var canvas = document.getElementById("canvas");

0 commit comments

Comments
 (0)