Skip to content

Commit 2d3d74d

Browse files
Dynamsoft-HenryDynamsoft-Henry
committed
Initialize
0 parents  commit 2d3d74d

File tree

15 files changed

+786
-0
lines changed

15 files changed

+786
-0
lines changed

‎.github/workflows/main.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: CI
4+
5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push events but only for the main branch
8+
push:
9+
branches:
10+
- main
11+
- preview
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
17+
jobs:
18+
# This workflow contains jobs called "Build-main" and "Build-Preview"
19+
Build-Main:
20+
if: ${{ github.ref == 'refs/heads/main' }}
21+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main
22+
with:
23+
doc-repo: code-parser-docs-mobile
24+
doc-url: code-parser/docs/mobile
25+
secrets: inherit
26+
27+
Build-Preview:
28+
if: ${{ github.ref == 'refs/heads/preview' }}
29+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
30+
with:
31+
doc-repo: code-parser-docs-mobile
32+
doc-url: code-parser/docs/mobile
33+
secrets: inherit
34+

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Dynamsoft Code Parser Docs - JS
2+
3+
This is the repository for maintaining the official documentation of Dynamsoft Code Parser Mobile Editions.

‎_config.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
repositoryUrl: https://github.com/dynamsoft-docs/code-parser-docs-mobile/blob/main
2+
repository: Dynamsoft-Docs/code-parser-docs-mobile
3+
docFullPath: https://www.dynamsoft.com/code-parser/docs/mobile/
4+
firstLevelUrl: /code-parser/docs/mobile/
5+
docHomePage: /code-parser/docs/mobile/introduction/
6+
7+
enumerations: /code-parser/docs/core/parameters/enum/
8+
parameters-reference: /code-parser/docs/core/parameters/reference/
9+
10+
dcp_android: /code-parser/docs/mobile/programming/android/
11+
dcp_android_api: /code-parser/docs/mobile/programming/android/api-reference/
12+
dcp_android_release_notes: /code-parser/docs/mobile/programming/android/release-notes/
13+
14+
dcp_ios: /code-parser/docs/mobile/programming/ios/
15+
dcp_ios_api: /code-parser/docs/mobile/programming/ios/api-reference/
16+
dcp_ios_release_notes: /code-parser/docs/mobile/programming/ios/release-notes/
17+
18+
dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
19+
dcv_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
20+
dcv_enumerations: /capture-vision/docs/core/enums/
21+
dcv_parameter_reference: /capture-vision/docs/core/parameters/reference/
22+
23+
assets: /code-parser/docs/mobile/assets/
24+
edit_icon: /code-parser/docs/mobile/assets/img-icon/edit-icon.png
25+
smile_icon: /code-parser/docs/mobile/assets/img-icon/icon-smile.png
26+
sad_icon: /code-parser/docs/mobile/assets/img-icon/icon-sad.png
27+
dbr_icon: /code-parser/docs/mobile/assets/img-icon/icon-dbr.svg
28+
dwt_icon: /code-parser/docs/mobile/assets/img-icon/icon-dwt.svg
29+
dnt_icon: /code-parser/docs/mobile/assets/img-icon/icon-dnt.svg
30+
31+
useVersionTree: true
32+
33+
baseurl: "/code-parser/docs/mobile"
34+
35+
plugins:
36+
- jemoji
37+
- jekyll-sitemap
38+
- jekyll-webp
39+
- jekyll-relative-links
40+
- jekyll-redirect-from
41+
- jekyll-readme-index
42+
- jekyll-seo-tag
43+
44+
defaults:
45+
- scope:
46+
path: ""
47+
values:
48+
layout: "default-layout"
49+
noTitleIndex: true
50+
needAutoGenerateSidebar: true
51+
needGenerateH3Content: true
52+
- scope:
53+
path: "programming/android"
54+
values:
55+
docRootName: "Label Recognizer Android Edition"
56+
docHomePage: "/code-parser/docs/mobile/programming/android/"
57+
- scope:
58+
path: "programming/ios"
59+
values:
60+
docRootName: "Label Recognizer iOS Edition"
61+
docHomePage: "/code-parser/docs/mobile/programming/ios/"
62+
- scope:
63+
path: "Hide_Tree_Page.html"
64+
values:
65+
sitemap: false
66+
67+
url: "https://www.dynamsoft.com" # sitemap root
68+

‎_data/full_tree.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
tree_file_list:
2+
- sidelist-full-tree.html
3+
- sidelist-programming/programming-android.html
4+
- sidelist-programming/programming-ios.html

‎_data/product_version.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
useGroupedVersion: true
2+
3+
version_info_list_desktop:
4+
- value: latest version

‎_includes/dcpNav.html‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<style>
2+
#cp-header .action-buttons { display: none; }
3+
#mdHeader { border-bottom: 0!important; }
4+
#sideBarCnt.sidebar-fixed { position: fixed; top: 88px; max-height: unset; }
5+
.rightSideMenu.rsm-fixed { position: fixed; top: 100px; }
6+
#docHead { top: 151px; }
7+
.productMenu .downloadBtn:hover { color: #ffffff!important; }
8+
@media (max-width: 1679px){
9+
#docHead {
10+
top: 145px;
11+
}
12+
}
13+
</style>
14+
15+
<div id="CodeParser" class="main">
16+
<div id="CodeParserMenu" class="productMenu">
17+
<div class="container pcProductMenu">
18+
<div class="row">
19+
<div class="col-xs-12">
20+
<ul class="menuList">
21+
<!---->
22+
<li class="title"><a class="orangeLink" href="{{site.docHomePage}}">Dynamsoft Code Parser</a></li>
23+
<li class="item overview">
24+
<!---->
25+
<a class="textUpperCase" href="{{site.release_notes}}">Release Notes</a>
26+
</li>
27+
<li class="item overview">
28+
<!---->
29+
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
30+
</li>
31+
</ul>
32+
</div>
33+
</div>
34+
</div>
35+
<div class="container mobileProductMenu">
36+
<div class="row">
37+
<div class="col-xs-12">
38+
<div class="productLogo" style="color:#fe8e14!important;font:10px">Dynamsoft Code Parser <i class="icon-orange-angle"></i></div>
39+
<div id="dcpCurrentPage" class="fontOswald fr currentPage">Resource Base</div>
40+
</div>
41+
</div>
42+
</div>
43+
<div class="mobileProductDetailMenu">
44+
<div class="container">
45+
<div class="row">
46+
<div class="col-xs-12">
47+
<ul class="menuList">
48+
<li class="item"><a href="{{site.release_notes}}">Release Notes</a></li>
49+
<li class="item"><a href="{{site.docHomePage}}">Documentation</a></li>
50+
</ul>
51+
</div>
52+
</div>
53+
</div>
54+
</div>
55+
</div>
56+
</div>

‎_includes/release-notes/product-highlight-2.0.0.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
* `DynamsoftCodeParser` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.
3+
* Added C++ Edition. With this new edition, developers can effortlessly integrate code parsing capabilities into their C++ applications.
4+
* Added supports to parse following code types:
5+
* [MRTD_TD1_ID]({{ site.code_types }}mrtd.html)
6+
* [MRTD_TD2_ID]({{ site.code_types }}mrtd.html)
7+
* [MRTD_TD2_VISA]({{ site.code_types }}mrtd.html)
8+
* [MRTD_TD3_PASSPORT]({{ site.code_types }}mrtd.html)
9+
* [MRTD_TD3_VISA]({{ site.code_types }}mrtd.html)
10+
* [VIN]({{ site.code_types }}vin.html)
11+
* [AAMVA_DL_ID]({{ site.code_types }}aamva-dl-id.html)
12+
* [AAMVA_DL_ID_WITH_MAG_STRIPE]({{ site.code_types }}aamva-dl-id.html)
13+
* [AADHAAR]({{ site.code_types }}aadhaar.html)
14+
* [SOUTH_AFRICA_DL]({{ site.code_types }}za-dl.html)
15+

‎_includes/sidelist-full-tree.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
<li lang="python">
3+
<a href="{{ site.python }}" class="otherLinkColour">Python Edition Introduction</a>
4+
</li>
5+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-python.html" -%}
6+
<li lang="java">
7+
<a href="{{ site.java }}" class="otherLinkColour">Java Edition Introduction</a>
8+
</li>
9+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-java.html" -%}
10+
<li lang="dotnet">
11+
<a href="{{ site.dotnet }}" class="otherLinkColour">.NET Edition Introduction</a>
12+
</li>
13+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-dotnet.html" -%}
14+
-->
15+
<li lang="cplusplus">
16+
<a href="{{ site.cpp }}" class="otherLinkColour">Introduction</a>
17+
</li>
18+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-cpp.html" -%}
19+
20+
<!--
21+
<li lang="c">
22+
<a href="{{ site.c }}" class="otherLinkColour">C Edition Introduction</a>
23+
</li>
24+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-c.html" -%}
25+
-->

‎_includes/sidelist-programming/programming-android.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<li lang="android" class="category">DEVELOPMENT</li>
2+
<li lang="android"><a href="{{ site.dcp_android }}user-guide/getting-started.html" class="otherLinkColour">User Guide</a></li>
3+
<li lang="android"><a class="otherLinkColour">API Reference</a>
4+
<ul>
5+
<li><a class="otherLinkColour">Classes</a>
6+
<ul>
7+
<li><a href="{{ site.dcp_android_api }}code-parser.html" class="otherLinkColour">CodeParser</a></li>
8+
<li><a href="{{ site.dcp_android_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
9+
<li><a href="{{ site.dcv_android_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
10+
<li><a href="{{ site.dcp_android_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
11+
</ul>
12+
</li>
13+
<li><a class="otherLinkColour">Enumerations</a>
14+
<ul>
15+
<li><a href="{{ site.enumerations }}core/error-code.html?lang=android" class="otherLinkColour">ErrorCode</a></li>
16+
<li><a href="{{ site.enumerations }}code-parser/mapping-status.html?lang=android" class="otherLinkColour">MappingStatus</a></li>
17+
<li><a href="{{ site.enumerations }}code-parser/validation-status.html?lang=android" class="otherLinkColour">ValidationStatus</a></li>
18+
</ul>
19+
</li>
20+
</ul>
21+
</li>
22+
<li lang="android"><a href="{{ site.dcp_android_release_notes }}" class="otherLinkColour">Release Notes</a>
23+
<ul >
24+
<li ><a href="{{ site.dcp_android_release_notes }}android-2.html" class="otherLinkColour">Version 2.x</a></li>
25+
</ul>
26+
</li>

‎_includes/sidelist-programming/programming-ios.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<li lang="objectivec-swift" class="category">DEVELOPMENT</li>
2+
<li lang="objectivec-swift"><a href="{{ site.dcp_ios }}user-guide/getting-started.html" class="otherLinkColour">User Guide</a></li>
3+
<li lang="objectivec-swift"><a class="otherLinkColour">API Reference</a>
4+
<ul>
5+
<li><a class="otherLinkColour">Classes</a>
6+
<ul>
7+
<li><a href="{{ site.dcp_ios_api }}code-parser.html" class="otherLinkColour">CodeParser</a></li>
8+
<li><a href="{{ site.dcp_ios_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
9+
<li><a href="{{ site.dcv_ios_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
10+
<li><a href="{{ site.dcp_ios_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
11+
</ul>
12+
</li>
13+
<li><a class="otherLinkColour">Enumerations</a>
14+
<ul>
15+
<li><a href="{{ site.enumerations }}core/error-code.html?lang=objc,swift" class="otherLinkColour">ErrorCode</a></li>
16+
<li><a href="{{ site.enumerations }}code-parser/mapping-status.html?lang=objc,swift" class="otherLinkColour">MappingStatus</a></li>
17+
<li><a href="{{ site.enumerations }}code-parser/validation-status.html?lang=objc,swift" class="otherLinkColour">ValidationStatus</a></li>
18+
</ul>
19+
</li>
20+
</ul>
21+
</li>
22+
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_release_notes }}" class="otherLinkColour">Release Notes</a>
23+
<ul >
24+
<li ><a href="{{ site.dcp_ios_release_notes }}ios-2.html" class="otherLinkColour">Version 2.x</a></li>
25+
</ul>
26+
</li>

0 commit comments

Comments
 (0)