Skip to content

Commit 3c49846

Browse files
author
Jing Ke
committed
[samples] add batch-mode, exercise-assessment, lasso and search.
1 parent 5a09c9a commit 3c49846

File tree

158 files changed

+90014
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+90014
-0
lines changed

.gitignore

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
################################################################################
2+
# Android
3+
################################################################################
4+
5+
# Built application files
6+
*.apk
7+
*.ap_
8+
9+
# Files for the ART/Dalvik VM
10+
*.dex
11+
12+
# Java class files
13+
*.class
14+
15+
# Generated files
16+
bin/
17+
gen/
18+
out/
19+
20+
# Gradle files
21+
.gradle/
22+
build/
23+
24+
# Local configuration file (sdk path, etc)
25+
local.properties
26+
27+
# Proguard folder generated by Eclipse
28+
proguard/
29+
30+
# Log Files
31+
*.log
32+
33+
# Android Studio Navigation editor temp files
34+
.navigation/
35+
36+
# Android Studio captures folder
37+
captures/
38+
39+
# IntelliJ
40+
*.iml
41+
.idea/workspace.xml
42+
.idea/tasks.xml
43+
.idea/gradle.xml
44+
.idea/assetWizardSettings.xml
45+
.idea/dictionaries
46+
.idea/libraries
47+
.idea/caches
48+
49+
# Keystore files
50+
# Uncomment the following line if you do not want to check your keystore files in.
51+
#*.jks
52+
53+
# External native build folder generated in Android Studio 2.2 and later
54+
.externalNativeBuild
55+
56+
# Google Services (e.g. APIs or Firebase)
57+
google-services.json
58+
59+
# Freeline
60+
freeline.py
61+
freeline/
62+
freeline_project_description.json
63+
64+
# fastlane
65+
fastlane/report.xml
66+
fastlane/Preview.html
67+
fastlane/screenshots
68+
fastlane/test_output
69+
fastlane/readme.md
70+
71+
################################################################################
72+
# MyScript
73+
################################################################################
74+
75+
# configuration files
76+
*.conf
77+
78+
# resource files
79+
*.res
80+
81+
# temporary folder
82+
temp/

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
We gladly welcome pull requests. If you have any questions, or want help solving a problem, feel free to stop by the [#MyScript forum](https://developer.myscript.com/support/).
4+
5+
## CLA
6+
7+
In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
8+
9+
Make sure you read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the contributing process.
10+
11+
## License
12+
13+
Those examples are licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).

LICENSE

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Copyright MyScript.
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
Unless required by applicable law or agreed to in writing, software
7+
distributed under the License is distributed on an "AS IS" BASIS,
8+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
See the License for the specific language governing permissions and
10+
limitations under the License.

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# MyScript Interactive Ink Samples
2+
3+
Interactive Ink SDK is the best way to integrate handwriting recognition capabilities into your Android application. Interactive Ink extends digital ink to allow users to more intuitively create, interact with, and share content in digital form. Handwritten text, mathematical equations or even diagrams are interpreted in real-time to be editable via simple gestures, responsive and easy to convert to a neat output.
4+
5+
You can find two examples that help you starting with Interactive Ink SDK on [MyScript Developer Portal](https://developer.myscript.com/docs/interactive-ink/latest/android/).
6+
7+
This repository comes in addition with further advanced Android examples that developers using Interactive Ink SDK can reuse inside their projects or from which they could draw inspiration.
8+
9+
## Installation
10+
11+
1. Clone the examples repository  `git clone https://github.com/MyScript/iink_sdk-additional-examples-android.git`.
12+
13+
2. If you already have a certificate go to next step, else claim to receive the free license to start develop your application by following the first steps of [Getting Started](https://developer.myscript.com/getting-started).
14+
15+
3. Copy this certificate to `certificate/src/main/java/com/myscript/certificate/MyCertificate.java`
16+
17+
4. The lasso example is illustrating how you can perform recognition of strokes captured with a lasso in the drawing area of your application: It is based on two "Drawing" parts: one for the drawing/writing area and the other one for the lasso capture. In lasso mode, the lassoed strokes are sent as a series of event to a batch recognition of a "Text" part and the result is displayed.
18+
19+
## Various examples
20+
21+
This repository provides you with an additional set of ready-to-use examples based on Android:
22+
23+
1. The batch mode sample is an example of how to integrate iink SDK off-screen, without any user interface. It consists in batch processing content, i.e. processing a series of pointer events corresponding to already collected ink strokes and exporting the recognition result. It comes with four pointer events samples that correspond to four different content types "Text", "Math", "Diagram", "Raw Content". Those content types are exported in respectively .txt, LaTeX, svg and JIIX formats. By default, the example is working with the "Text" content type but all you have to do to try another type is modifying the content type in the MainActivity class:
24+
25+
~~~#!java
26+
// Choose type of content ("Text", "Math", "Diagram", "Raw Content")
27+
private static String partType = "Text";
28+
~~~
29+
30+
2. The exercise assessment illustrates the case when you want to use several writing areas each one for a specific purpose (here the example is based on problem solving and score writing) in your application. It is thus using multiple editors, one per writing area, as each one has a different purpose: one of them is dedicated to "Math" content types and the three other ones to "Text" content type.
31+
32+
3. The search example shows how to perform word search on raw digital ink and highlights the result found in the ink. it is based on "Raw Content" Content Type.
33+
34+
## Documentation
35+
36+
A complete guide is available on [MyScript Developer Portal](https://developer.myscript.com/docs/interactive-ink/latest/android/).
37+
38+
The API Reference is available directly in Android Studio once the dependencies are downloaded.
39+
40+
## Getting support
41+
42+
You can get some support from the dedicated section on [MyScript Developer Portal](https://developer.myscript.com/support/).
43+
44+
## Sharing your feedback
45+
46+
Made a cool app with Interactive Ink? Ready to cross join our marketing efforts? We would love to hear about you!
47+
We’re planning to showcase apps using it so let us know by sending a quick mail to [myapp@myscript.com](mailto://myapp@myscript.com).
48+
49+
## Contributing
50+
51+
We welcome your contributions:
52+
If you would like to extend those examples for your needs, feel free to fork them!
53+
Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitting your pull request.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
apply plugin: 'com.android.library'
2+
3+
android {
4+
compileSdkVersion project.ext.compileSdkVersion
5+
6+
defaultConfig {
7+
minSdkVersion project.ext.minSdkVersion
8+
targetSdkVersion project.ext.targetSdkVersion
9+
versionCode 1300
10+
versionName '1.3.0'
11+
12+
vectorDrawables.useSupportLibrary true
13+
}
14+
}
15+
16+
dependencies {
17+
implementation "com.android.support:appcompat-v7:${project.ext.supportLibraryVersion}"
18+
implementation "com.google.code.gson:gson:2.8.2"
19+
api "com.myscript:iink:1.3.0"
20+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<manifest package="com.myscript.iink.uireferenceimplementation" />
171 KB
Binary file not shown.
325 KB
Binary file not shown.

0 commit comments

Comments
 (0)