diff --git a/README.md b/README.md index 00324cd..b2fba72 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -# Dynamsoft Code Parser Docs - JS +# Dynamsoft Code Parser Docs - Mobile This is the repository for maintaining the official documentation of Dynamsoft Code Parser Mobile Editions. diff --git a/index.md b/index.md deleted file mode 100644 index 72700ed..0000000 --- a/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: home-page -title: Dynamsoft Code Parser SDK Documentation -keywords: dynamsoft code parser, dcp, documentation -breadcrumbText: HomePage -description: Dynamsoft Code Parser SDK Documentation Homepage ---- - -# Dynamsoft Code Parser Documentation diff --git a/programming/android/api-reference/index.md b/programming/android/api-reference/index.md deleted file mode 100644 index 7aab8e6..0000000 --- a/programming/android/api-reference/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: default-layout -title: Main Page - Dynamsoft Code Parser SDK Android Edition API Reference -description: This is the main page of Dynamsoft Code Parser SDK Android Edition API Reference. -keywords: api reference, Android -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# API Reference - Dynamsoft Code Parser SDK Android Edition - -## Classes - -* [`CodeParser`](code-parser.html) -* [`LicenseManager`]({{ site.dcv_android_api }}license/license-manager.html) -* [`ParsedResultItem`](parsed-result-item.html) -* [`ParsedResult`](parsed-result.html) - -## Enumerations - -* [`ErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=android) -* [`MappingStatus`]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=android) -* [`ValidationStatus`]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=android) diff --git a/programming/android/index.md b/programming/android/index.md deleted file mode 100644 index 28fd869..0000000 --- a/programming/android/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default-layout -title: Main Page - Dynamsoft Code Parser SDK Android Edition -description: This is the main page of Dynamsoft Code Parser SDK Android Edition. -keywords: Android -needAutoGenerateSidebar: true -needGenerateH3Content: true ---- - -# Dynamsoft Code Parser Android Edition Documentation - -## Getting Started - -- [User Guide](user-guide/getting-started.md) - -## API Reference - -- [API Reference](api-reference/index.md) - -## Release Notes - -- [Version 2.x](release-notes/android-2.md) diff --git a/programming/android/release-notes/android-2.md b/programming/android/release-notes/android-2.md deleted file mode 100644 index 8472dd4..0000000 --- a/programming/android/release-notes/android-2.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default-layout -title: Release Notes v2.x - Dynamsoft Code Parser SDK Android Edition -description: This is the release notes page of Dynamsoft Code Parser SDK Android Edition v2.x. -keywords: release notes, Android -needGenerateH3Content: false ---- - -# Release Notes for Android Edition - 2.x - -## 2.2.11 (05/15/2024) - -- Moved the GJSON dependency from the `DynamsoftCodeParser` library to `DynamsoftCore` library. - -## 2.2.10 (04/16/2024) - -### Improved - -- Security update for `DynamsoftCodeParser` and its related libraries. - -### Fixed - -- Small fixes and tweaks. - -## 2.0.20 (12/07/2023) - -{%- include release-notes/product-highlight-2.0.0.md -%} - diff --git a/programming/android/release-notes/index.md b/programming/android/release-notes/index.md deleted file mode 100644 index 5179007..0000000 --- a/programming/android/release-notes/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: default-layout -title: Release Notes - Dynamsoft Code Parser SDK Android Edition -description: This is the release notes page of Dynamsoft Code Parser SDK Android Edition. -keywords: release notes, Android -needAutoGenerateSidebar: false ---- - -# Release Notes - Android Edition - -- [2.2.11 (05/15/2024)](android-2.md#2211-05152024) -- [2.2.10 (04/16/2024)](android-2.md#2210-04162024) -- [2.0.20 (12/07/2023)](android-2.md#2020-12072023) diff --git a/programming/android/user-guide/getting-started.md b/programming/android/user-guide/getting-started.md deleted file mode 100644 index b543b3a..0000000 --- a/programming/android/user-guide/getting-started.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -layout: default-layout -title: User Guide - Dynamsoft Code Parser SDK Android Edition -description: This is the user guide of Dynamsoft Code Parser SDK Android Edition. -keywords: user guide, Android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Dynamsoft Code Parser - Android User Guide - -- [Dynamsoft Code Parser - Android User Guide](#dynamsoft-code-parser---android-user-guide) - - [Requirements](#requirements) - - [Add the Libraries](#add-the-libraries) - - [Build Your First Application](#build-your-first-application) - - [Create a New Project](#create-a-new-project) - - [Include the Library](#include-the-library) - - [Initialize the License](#initialize-the-license) - - [Initialize Code Parser And Parse the Code Bytes](#initialize-code-parser-and-parse-the-code-bytes) - - [Display Parsed Results](#display-parsed-results) - - [Build and Run the Project](#build-and-run-the-project) - -## Requirements - -- Supported OS: Android 5.0 (API Level 21) or higher. -- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**. -- Development Environment: Android Studio 2022.2.1 or higher. - -## Add the Libraries - -The Dynamsoft Code Parser (DCP) Android SDK comes with four libraries: - - | File | Description | - |---------|-------------| - | `DynamsoftCodeParser.aar` | The Dynamsoft Code Parser library, which includes code parsing logic and related APIs. | - | `DynamsoftCore.aar` | The core library, which includes common basic structures and intermediate result related APIs. | - | `DynamsoftLicense.aar` | The license library, which includes license related APIs. | - | `DynamsoftCodeParserDedicator.aar`| The code parser helper library, which includes some validation functions used by the SDK.| - -1. Open the file `[App Project Root Path]\app\build.gradle` and add the Maven repository: - - ```groovy - repositories { - maven { - url "https://download2.dynamsoft.com/maven/aar" - } - } - ``` - -2. Add the references in the dependencies: - - ```groovy - dependencies { - implementation 'com.dynamsoft:dynamsoftcodeparser:2.2.10' - implementation 'com.dynamsoft:dynamsoftcodeparserdedicator:1.2.20' - implementation 'com.dynamsoft:dynamsoftcore:3.2.30' - implementation 'com.dynamsoft:dynamsoftlicense:3.2.20' - } - ``` - -3. Click **Sync Now**. After the synchronization is complete, the SDK is added to the project. - -## Build Your First Application - -In this section, we are going to explain how to create a simple `HelloWorld` app for parsing text or bytes. - ->Note: -> ->- Android Studio 2022.3.1 is used here in this guide. - -### Create a New Project - -1. Open Android Studio and select New Project… in the File > New > New Project… menu to create a new project. - -2. Choose the correct template for your project. In this sample, we'll use `Empty Activity`. - -3. When prompted, choose your app name (`HelloWorld`) and set the Save location, Language, and Minimum SDK (21) - >Note: With minSdkVersion set to 21, your app is available on more than 94.1% of devices on the Google Play Store (last update: March 2021). - -### Include the Library - -Add the SDK to your new project. Please read [Add the Libraries](#add-the-libraries) section for more details. - -### Initialize the License - -1. Initialize the license in the file `MainActivity.java`. - - ```java - import com.dynamsoft.license.LicenseManager; - public class MainActivity extends AppCompatActivity { - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", this, (isSuccess, error) -> { - if (!isSuccess) { - error.printStackTrace(); - } - }); - } - } - ``` - - >Note: - > - >- The license string here grants a time-limited free trial which requires network connection to work. - >- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dcp&utm_source=guide&package=android){:target="_blank"} link. Offline trial license is also available by [contacting us](https://www.dynamsoft.com/contact/){:target="_blank"}. - >- If you download the Installation Package, it comes with a 30-day trial license by default. - -### Initialize Code Parser And Parse the Code Bytes - -1. Import and initialize the `CodeParser`. - - ```java - import com.dynamsoft.dcp.CodeParser; - public class MainActivity extends AppCompatActivity { - private CodeParser mParser; - @Override - protected void onCreate(Bundle savedInstanceState) { - ... - mParser = new CodeParser(this); - } - } - ``` - -2. In the Project window, open **app > res > layout > `activity_main.xml`**, create a "Parse" button control under the root node. - - ```xml -