Skip to content

Commit c79cc82

Browse files
authored
Feat: add FAQ section (#30)
* feat: add FAQ (#29) * feat: add FAQ
1 parent 1bc4b04 commit c79cc82

File tree

5 files changed

+37
-2
lines changed

5 files changed

+37
-2
lines changed

_data/full_tree.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ tree_file_list:
44
- sidelist-introduction.html
55
- sidelist-guides.html
66
- sidelist-releasenotes.html
7+
- sidelist-faq.html
78
- sidelist-full-tree.html
89
- sidelist-api-v1.1.html
910
- sidelist-codegallery-v1.1.html
1011
- sidelist-introduction-v1.1.html
1112
- sidelist-guides-v1.1.html
1213
- sidelist-releasenotes-v1.1.html
13-
- sidelist-full-tree-v1.1.html
14+
- sidelist-full-tree-v1.1.html

_includes/sidelist-faq.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<li><a href="/mrz-scanner/docs/web/faq/index.html" class="otherLinkColour">FAQ</a>
2+
</li>

_includes/sidelist-full-tree.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%}
55
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%}
6-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}
6+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}
7+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-faq.html" -%}

faq/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
layout: default-layout
3+
needAutoGenerateSidebar: true
4+
needGenerateH3Content: true
5+
noTitleIndex: false
6+
title: MRZ Scanner JavaScript Edition - FAQ
7+
keywords: Documentation, MRZ Scanner JavaScript Edition, FAQ, Frequently Asked Questions
8+
breadcrumbText: FAQ
9+
description: MRZ Scanner JavaScript Edition Documentation Frequently Asked Questions
10+
permalink: /faq/index.html
11+
---
12+
13+
# Frequently Asked Questions
14+
15+
1. [Can the MRZ Scanner process static images, or does it only work with live cameras?](#can-the-mrz-scanner-process-static-images-or-does-it-only-work-with-live-cameras)
16+
2. [Does MRZ Scanner perform data validation?](#does-the-mrz-scanner-perform-data-validation)
17+
3. [How do I use the scanned result?](#how-do-i-use-the-scanned-result)
18+
19+
## Can the MRZ Scanner process static images, or does it only work with live cameras?
20+
21+
Yes, the MRZ Scanner can read from static images and image files, along with the typical use case of scanning from a live camera feed.
22+
23+
## Does the MRZ Scanner perform data validation?
24+
25+
**No**. MRZ Scanner JavaScript Edition performs all image capture, image enhancement, and MRZ parsing on-device, to give you full control of your data. The MRZ Scanner processes the data on the client device without passing the data to external servers. Your application must implement data validation on the decoded MRZ data after reading with the MRZ Scanner if your use case requires data validation.
26+
27+
28+
## How do I use the scanned result?
29+
30+
The simplest implementation uses the default UI and does not take action after scanning. You can customize the behavior by handling callbacks provided by the API. The [`launch()`]({{ site.api }}mrz-scanner.html#launch) method returns the scanned result as the type [`MRZResult`]({{ site.api }}mrz-scanner.html#mrzresult), which includes the image of the document, as well as the parsed MRZ data separated into fields.

index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ description: MRZ Scanner JavaScript Edition Documentation Homepage
1919
- [Code Gallery]({{ site.codegallery }}index.html)
2020
- [API Reference]({{ site.api }}index.html)
2121
- [Release Notes]({{ site.releasenotes }}index.html)
22+
- [FAQ](/mrz-scanner/docs/web/faq/index.html)

0 commit comments

Comments
 (0)