Preview

.github/workflows/main.yml

@@ -0,0 +1,25 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push events but only for the main branch
+  push:
+    branches: 
+    - main 
+    #- preview 
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains jobs called "Build-Master"
+  Build-Main:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main
+    with:
+      doc-repo: mrz-scanner-docs-js
+      doc-url: mrz-scanner/docs/web
+    secrets: inherit

.gitignore

@@ -0,0 +1,29 @@
+.DS_Store
+/.vs
+Gemfile
+Hide_Tree_Page.md
+sitemap.xml
+_includes/productNav/*
+_includes/auto-version-list.html
+_includes/head.html
+_includes/liquid_autoGenerateHistoryList.html
+_includes/liquid_breadcrumb.html
+_includes/liquid_generateFullTree.html
+_includes/liquid_searchVersionTreeFile.html
+_includes/livehelp.html
+_includes/main-page-head.html
+_includes/page_footer.html
+_includes/page_header.html
+_includes/productNav_OLD.html
+_includes/productNav.html
+_includes/search-input.html
+_includes/trialLicense.html
+_layouts/*
+_plugins/*
+assets/css/*
+assets/font-face/*
+assets/img-icon/*
+assets/js/*
+assets/scripts/*
+_site/*
+Gemfile.lock

README.md

@@ -1 +1,21 @@
-Dynamsoft MRZ Scanner JS Edition Docs
+# Introduction 
+In today's world of constant travel and activities that require identity verification, it is important to have the tools necessary in order to quickly and accurately capture and recognize all of that personal information in one go. Most travel and identity documents today come with a *Machine Readable Zone* (MRZ for short) that stores and encrypts all of the information of that identity document in just a few lines.
+
+When it comes to reading MRZ documents, it is important to find a library that not only recognizes the MRZ lines, but also then parses them into human readable fields for the user. With the **MRZ Scanner JavaScript Edition**, there is no better library to help you achieve that for any kind of web application you are building, all with just a few lines of code!
+
+# Getting Started
+
+Before you get started with the development process, we recommend reading through the full [Introduction to the MRZ Scanner](https://www.dynamsoft.com/mrz-scanner/docs/web/introduction/index.html) to give you an idea of the capabilities of the library, as well as the system requirements and more.
+
+To get started with the MRZ Scanner JavaScript Edition, please refer to the full [User Guide](https://www.dynamsoft.com/mrz-scanner/docs/web/guides/mrz-scanner.html) and [Customization Guide](https://www.dynamsoft.com/mrz-scanner/docs/web/guides/mrz-scanner-customization.html).
+
+The full API reference can be found [here](https://www.dynamsoft.com/mrz-scanner/docs/web/api/mrz-scanner.html).
+
+# Build and Test
+
+To test out the SDK, you can retrieve the Hello World sample code from this [repo](https://github.com/Dynamsoft/mrz-scanner-javascript).Once you have the repo downloaded, please follow the instructions [here](https://github.com/Dynamsoft/mrz-scanner-javascript?tab=readme-ov-file#building-the-library-from-source) to build the sample and test it out.
+
+
+# Support
+
+If you have any questions, do not hesitate to get in touch with the [Dynamsoft Support Team](https://www.dynamsoft.com/company/contact/).

_config.yml

@@ -0,0 +1,67 @@
+repository: dynamsoft-docs/mrz-scanner-docs-js
+repositoryUrl: https://github.com/dynamsoft-docs/mrz-scanner-docs-js/blob/main
+docFullPath: https://www.dynamsoft.com/mrz-scanner/docs/web/
+firstLevelUrl: /mrz-scanner/docs/web
+docHomePage: /mrz-scanner/docs/web/introduction/
+
+introduction: /mrz-scanner/docs/web/introduction/
+gettingstarted: /mrz-scanner/docs/web/gettingstarted/
+codegallery: /mrz-scanner/docs/web/codegallery/
+api: /mrz-scanner/docs/web/api/
+releasenotes: /mrz-scanner/docs/web/releasenotes/
+
+guides: /mrz-scanner/docs/web/guides/
+
+dcvb_introduction: /capture-vision/docs/core/introduction/
+dcvb_architecture: /capture-vision/docs/core/architecture/
+dcvb_parameters: /capture-vision/docs/core/parameters/reference/
+dcvb_parameter_file: /capture-vision/docs/core/parameters/file/
+dcvb_enums: /capture-vision/docs/core/enums/
+license_activation: /capture-vision/docs/core/license/
+
+dcvb_js: /capture-vision/docs/web/programming/javascript/
+dcvb_js_api: /capture-vision/docs/web/programming/javascript/api-reference/
+dbr_js: /barcode-reader/docs/web/programming/javascript/
+dlr_js: /label-recognition/docs/web/programming/javascript/
+ddn_js: /document-normalizer/docs/web/programming/javascript/
+dcp_js: /code-parser/docs/web/programming/javascript/
+dce_js: /camera-enhancer/docs/web/programming/javascript/
+dbr_js_api: /barcode-reader/docs/web/programming/javascript/api-reference/
+dlr_js_api: /label-recognition/docs/web/programming/javascript/api-reference/
+ddn_js_api: /document-normalizer/docs/web/programming/javascript/api-reference/
+dcp_js_api: /code-parser/docs/web/programming/javascript/api-reference/
+dce_js_api: /camera-enhancer/docs/web/programming/javascript/api-reference/
+code_types: /code-parser/docs/core/code-types/
+dcvb_root: /capture-vision/docs/core/
+mrz_js: /mrz-scanner/docs/web/
+
+useVersionTree: true
+
+assets: /mrz-scanner/docs/web/assets/
+edit_icon: /mrz-scanner/docs/web/assets/img-icon/edit-icon.png
+smile_icon: /mrz-scanner/docs/web/assets/img-icon/icon-smile.png
+sad_icon: /mrz-scanner/docs/web/assets/img-icon/icon-sad.png
+
+baseurl: "/mrz-scanner/docs/web"
+
+download: "/mrz-scanner/downloads/"
+
+plugins:
+  - jemoji
+  - jekyll-sitemap
+
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default-layout"
+      noTitleIndex: true
+      needAutoGenerateSidebar: true
+      needGenerateH3Content: true
+  - scope:
+      path: "Hide_Tree_Page.html"
+    values:
+      sitemap: false
+
+url: "https://www.dynamsoft.com" # sitemap root

_data/full_tree.yml

@@ -0,0 +1,13 @@
+tree_file_list:
+  - sidelist-api.html
+  - sidelist-codegallery.html
+  - sidelist-introduction.html
+  - sidelist-guides.html
+  - sidelist-releasenotes.html
+  - sidelist-full-tree.html
+  - sidelist-api-v1.1.html
+  - sidelist-codegallery-v1.1.html
+  - sidelist-introduction-v1.1.html
+  - sidelist-guides-v1.1.html
+  - sidelist-releasenotes-v1.1.html
+  - sidelist-full-tree-v1.1.html

_data/product_version.yml

@@ -0,0 +1,11 @@
+useGroupedVersion: true
+
+version_info_list:
+  - value: latest version
+  - value: 1.x
+    child:
+      - 1.1
+
+
+
+

_includes/sidelist-api.html

@@ -0,0 +1,8 @@
+<li><a class="otherLinkColour">API Reference</a>
+    <ul>
+        <li><a href="{{ site.api }}mrz-scanner.html" class="otherLinkColour">MRZ Scanner API</a></li> 
+    </ul>
+    <ul>
+        <li><a href="{{ site.api }}enums-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Enumerations</a></li> 
+    </ul>
+</li>

_includes/sidelist-codegallery.html

@@ -0,0 +1,8 @@
+<li><a href="{{ site.codegallery }}index.html" class="otherLinkColour">Code Gallery</a>
+    <ul>
+        <li><a href="{{ site.codegallery }}helloworld/index.html" class="otherLinkColour">Hello World</a></li> 
+    </ul>
+    <ul>
+        <li><a href="{{ site.codegallery }}demo/index.html" class="otherLinkColour">Demo</a></li> 
+    </ul>
+</li>

_includes/sidelist-full-tree-v1.1.html

@@ -0,0 +1,5 @@
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction-v1.1.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides-v1.1.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery-v1.1.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api-v1.1.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes-v1.1.html" -%}

_includes/sidelist-full-tree.html

@@ -0,0 +1,6 @@
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides.html" -%}
+<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%}
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}

_includes/sidelist-gettingstarted.html

@@ -0,0 +1,7 @@
+<li><a class="otherLinkColour">Getting Started</a>
+    <ul>
+        <li><a href="{{ site.gettingstarted }}sys_requirement.html" class="otherLinkColour">System Requirements</a></li>
+        <li><a href="{{ site.gettingstarted }}license.html" class="otherLinkColour">License</a></li>
+        <li><a href="{{ site.gettingstarted }}add_dependency.html" class="otherLinkColour">Adding the Dependency</a></li>   
+    </ul>
+</li>

_includes/sidelist-guides-v1.1.html

@@ -0,0 +1,5 @@
+<li><a class="otherLinkColour">Developer Guides</a>
+    <ul>
+        <li><a href="{{ site.guides }}mrz-scanner-v1.1.html" class="otherLinkColour">MRZ Scanner User Guide</a></li> 
+    </ul>
+</li>

_includes/sidelist-guides.html

@@ -0,0 +1,6 @@
+<li><a class="otherLinkColour">Developer Guides</a>
+    <ul>
+        <li><a href="{{ site.guides }}mrz-scanner.html" class="otherLinkColour">MRZ Scanner User Guide</a></li> 
+        <li><a href="{{ site.guides }}mrz-scanner-customization.html" class="otherLinkColour">MRZ Scanner Customization Guide</a></li> 
+    </ul>
+</li>

_includes/sidelist-introduction.html

@@ -0,0 +1 @@
+<li><a href="{{ site.introduction }}index.html" class="otherLinkColour">Introduction</a></li>

_includes/sidelist-releasenotes.html

@@ -0,0 +1 @@
+<li><a href="{{ site.releasenotes }}index.html" class="otherLinkColour">Release Notes</a></li>

api/enums-mrz-scanner.md

@@ -0,0 +1,59 @@
+---
+layout: default-layout
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: false
+title: Dynamsoft MRZ Scanner JavaScript Edition - API Reference
+keywords: Documentation, MRZ Scanner JavaScript Edition, API, APIs, Enumeration, Enums, Enum
+breadcrumbText: API References
+description: Dynamsoft MRZ Scanner JavaScript Edition - API Reference
+---
+
+# MRZ Scanner API Enumerations
+
+The MRZ Scanner comes with a few enumerations for some of the configuration properties.
+
+## EnumMRZDocumentType
+
+### Syntax
+
+```ts
+enum EnumMRZDocumentType {
+  Passport = "passport",
+  TD1 = "td1",
+  TD2 = "td2",
+}
+```
+
+## EnumResultStatus
+
+### Syntax
+
+```ts
+export enum EnumResultStatus {
+  RS_SUCCESS = 0,
+  RS_CANCELLED = 1,
+  RS_FAILED = 2,
+}
+```
+
+## EnumMRZData
+
+### Syntax
+
+```ts
+export enum EnumMRZData {
+  InvalidFields = "invalidFields",
+  DocumentType = "documentType",
+  DocumentNumber = "documentNumber",
+  MRZText = "mrzText",
+  FirstName = "firstName",
+  LastName = "lastName",
+  Age = "age",
+  Sex = "sex",
+  IssuingState = "issuingState",
+  Nationality = "nationality",
+  DateOfBirth = "dateOfBirth",
+  DateOfExpiry = "dateOfExpiry",
+}
+```

api/index.md

@@ -0,0 +1,49 @@
+---
+layout: default-layout
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+title: MRZ Scanner JavaScript Edition - API Reference Index
+keywords: Documentation, MRZ Scanner JavaScript Edition, API Index
+description: MRZ Scanner JavaScript Edition Documentation API Reference Index
+---
+
+# API Reference Index
+
+The MRZ Scanner library comes with a number of classes and interfaces which we will dive into in the API documentation. There are three main classes: **MRZScanner**, **MRZScannerView**, **MRZResultView**, and **MRZResult**. In terms of interfaces, the main ones are: **MRZScannerConfig**, **MRZScannerViewConfig**, and **MRZResultViewConfig**.
+
+Please read through the [**full API reference**](mrz-scanner.md), but you can find a summarized list of the classes, interfaces, and enums below.
+
+## Classes
+
+1. [MRZScanner](mrz-scanner.md#mrzscanner) - The main class of the MRZ Scanner, which is used to create and configure the MRZ Scanner instance.
+
+2. MRZScannerView - Represents the main view of the MRZ Scanner where the scanning operation occurs.
+
+3. MRZResultView - Displays the parsed MRZ result in human readable fields, along with a cropped image of the MRZ document. 
+
+## Interfaces
+
+1. [MRZScannerConfig](mrz-scanner.md#mrzscannerconfig) - The main configuration class of the MRZScanner. It is used to assign the supported MRTD formats of your application as well as the configurations of the **MRZScannerView** and the **MRZResultView**.
+
+2. [MRZScannerViewConfig](mrz-scanner.md#mrzscannerviewconfig) - Configures the different UI elements of the **MRZScannerView**.
+
+3. [MRZResultViewConfig](mrz-scanner.md#mrzresultviewconfig) - Configures the different UI elements of the **MRZResultView**.
+
+4. [MRZResultViewToolbarButtonsConfig](mrz-scanner.md#mrzresultviewtoolbarbuttonsconfig) - Configures the toolbar buttons of the **MRZResultView**.
+
+4. [MRZResult](mrz-scanner.md#mrzresult) - Represents a typical MRZ result along with all of the parsed fields that come with it.
+
+5. [MRZData](mrz-scanner.md#mrzdata) - Represents the parsed MRZ data that is part of the `MRZResult`.
+
+6. [MRZDate](mrz-scanner.md#mrzdate) - Represents a date in the MRZ fields - which is usually used for date of birth and the date of expiry.
+
+## Enumerations
+
+All of the enumerations can be found [**here**](enums-mrz-scanner.md). Here is a summarized list of the available enumerations.
+
+1. [EnumMRZDocumentType](enums-mrz-scanner.md#enummrzdocumenttype) - An enumeration to represent the different types of MRTD formats that the MRZScanner supports.
+
+2. [EnumResultStatus](enums-mrz-scanner.md#enumresultstatus) - An enumeration to represent the status of a MRZ result.
+
+3. [EnumMRZData](enums-mrz-scanner.md) - An enumeration to represent the different fields of the `MRZData` interface.